3 * Copyright (c) 1996-2006, Nick Ing-Simmons
4 * Copyright (c) 2006, 2007, 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.
15 /* This file contains the functions needed to implement PerlIO, which
16 * is Perl's private replacement for the C stdio library. This is used
17 * by default unless you compile with -Uuseperlio or run with
18 * PERLIO=:stdio (but don't do this unless you know what you're doing)
22 * If we have ActivePerl-like PERL_IMPLICIT_SYS then we need a dTHX to get
23 * at the dispatch tables, even when we do not need it for other reasons.
24 * Invent a dSYS macro to abstract this out
26 #ifdef PERL_IMPLICIT_SYS
36 # ifndef USE_CROSS_COMPILE
43 #define PERLIO_NOT_STDIO 0
44 #if !defined(PERLIO_IS_STDIO) && !defined(USE_SFIO)
50 * This file provides those parts of PerlIO abstraction
51 * which are not #defined in perlio.h.
52 * Which these are depends on various Configure #ifdef's
56 #define PERL_IN_PERLIO_C
59 #ifdef PERL_IMPLICIT_CONTEXT
67 /* Missing proto on LynxOS */
71 /* Call the callback or PerlIOBase, and return failure. */
72 #define Perl_PerlIO_or_Base(f, callback, base, failure, args) \
73 if (PerlIOValid(f)) { \
74 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;\
75 if (tab && tab->callback) \
76 return (*tab->callback) args; \
78 return PerlIOBase_ ## base args; \
81 SETERRNO(EBADF, SS_IVCHAN); \
84 /* Call the callback or fail, and return failure. */
85 #define Perl_PerlIO_or_fail(f, callback, failure, args) \
86 if (PerlIOValid(f)) { \
87 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;\
88 if (tab && tab->callback) \
89 return (*tab->callback) args; \
90 SETERRNO(EINVAL, LIB_INVARG); \
93 SETERRNO(EBADF, SS_IVCHAN); \
96 /* Call the callback or PerlIOBase, and be void. */
97 #define Perl_PerlIO_or_Base_void(f, callback, base, args) \
98 if (PerlIOValid(f)) { \
99 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;\
100 if (tab && tab->callback) \
101 (*tab->callback) args; \
103 PerlIOBase_ ## base args; \
106 SETERRNO(EBADF, SS_IVCHAN)
108 /* Call the callback or fail, and be void. */
109 #define Perl_PerlIO_or_fail_void(f, callback, args) \
110 if (PerlIOValid(f)) { \
111 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;\
112 if (tab && tab->callback) \
113 (*tab->callback) args; \
115 SETERRNO(EINVAL, LIB_INVARG); \
118 SETERRNO(EBADF, SS_IVCHAN)
120 #if defined(__osf__) && _XOPEN_SOURCE < 500
121 extern int fseeko(FILE *, off_t, int);
122 extern off_t ftello(FILE *);
127 EXTERN_C int perlsio_binmode(FILE *fp, int iotype, int mode);
130 perlsio_binmode(FILE *fp, int iotype, int mode)
133 * This used to be contents of do_binmode in doio.c
136 # if defined(atarist) || defined(__MINT__)
137 PERL_UNUSED_ARG(iotype);
140 ((FILE *) fp)->_flag |= _IOBIN;
142 ((FILE *) fp)->_flag &= ~_IOBIN;
148 PERL_UNUSED_ARG(iotype);
150 if (PerlLIO_setmode(fp, mode) != -1) {
152 if (PerlLIO_setmode(fileno(fp), mode) != -1) {
154 # if defined(WIN32) && defined(__BORLANDC__)
156 * The translation mode of the stream is maintained independent
158 * the translation mode of the fd in the Borland RTL (heavy
159 * digging through their runtime sources reveal). User has to
161 * the mode explicitly for the stream (though they don't
163 * this anywhere). GSAR 97-5-24
169 fp->flags &= ~_F_BIN;
177 # if defined(USEMYBINMODE)
179 # if defined(__CYGWIN__)
180 PERL_UNUSED_ARG(iotype);
182 if (my_binmode(fp, iotype, mode) != FALSE)
188 PERL_UNUSED_ARG(iotype);
189 PERL_UNUSED_ARG(mode);
197 #define O_ACCMODE 3 /* Assume traditional implementation */
201 PerlIO_intmode2str(int rawmode, char *mode, int *writing)
203 const int result = rawmode & O_ACCMODE;
208 ptype = IoTYPE_RDONLY;
211 ptype = IoTYPE_WRONLY;
219 *writing = (result != O_RDONLY);
221 if (result == O_RDONLY) {
225 else if (rawmode & O_APPEND) {
227 if (result != O_WRONLY)
232 if (result == O_WRONLY)
239 if (rawmode & O_BINARY)
245 #ifndef PERLIO_LAYERS
247 PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode, const char *names)
249 if (!names || !*names
250 || strEQ(names, ":crlf")
251 || strEQ(names, ":raw")
252 || strEQ(names, ":bytes")
256 Perl_croak(aTHX_ "Cannot apply \"%s\" in non-PerlIO perl", names);
264 PerlIO_destruct(pTHX)
269 PerlIO_binmode(pTHX_ PerlIO *fp, int iotype, int mode, const char *names)
272 PERL_UNUSED_ARG(iotype);
273 PERL_UNUSED_ARG(mode);
274 PERL_UNUSED_ARG(names);
277 return perlsio_binmode(fp, iotype, mode);
282 PerlIO_fdupopen(pTHX_ PerlIO *f, CLONE_PARAMS *param, int flags)
284 #if defined(PERL_MICRO) || defined(__SYMBIAN32__)
287 #ifdef PERL_IMPLICIT_SYS
288 return PerlSIO_fdupopen(f);
291 return win32_fdupopen(f);
294 const int fd = PerlLIO_dup(PerlIO_fileno(f));
298 const int omode = djgpp_get_stream_mode(f);
300 const int omode = fcntl(fd, F_GETFL);
302 PerlIO_intmode2str(omode,mode,NULL);
303 /* the r+ is a hack */
304 return PerlIO_fdopen(fd, mode);
309 SETERRNO(EBADF, SS_IVCHAN);
319 * De-mux PerlIO_openn() into fdopen, freopen and fopen type entries
323 PerlIO_openn(pTHX_ const char *layers, const char *mode, int fd,
324 int imode, int perm, PerlIO *old, int narg, SV **args)
328 Perl_croak(aTHX_ "More than one argument to open");
330 if (*args == &PL_sv_undef)
331 return PerlIO_tmpfile();
333 const char *name = SvPV_nolen_const(*args);
334 if (*mode == IoTYPE_NUMERIC) {
335 fd = PerlLIO_open3(name, imode, perm);
337 return PerlIO_fdopen(fd, mode + 1);
340 return PerlIO_reopen(name, mode, old);
343 return PerlIO_open(name, mode);
348 return PerlIO_fdopen(fd, (char *) mode);
353 XS(XS_PerlIO__Layer__find)
357 Perl_croak(aTHX_ "Usage class->find(name[,load])");
359 const char * const name = SvPV_nolen_const(ST(1));
360 ST(0) = (strEQ(name, "crlf")
361 || strEQ(name, "raw")) ? &PL_sv_yes : &PL_sv_undef;
368 Perl_boot_core_PerlIO(pTHX)
370 newXS("PerlIO::Layer::find", XS_PerlIO__Layer__find, __FILE__);
376 #ifdef PERLIO_IS_STDIO
383 * Does nothing (yet) except force this file to be included in perl
384 * binary. That allows this file to force inclusion of other functions
385 * that may be required by loadable extensions e.g. for
386 * FileHandle::tmpfile
390 #undef PerlIO_tmpfile
397 #else /* PERLIO_IS_STDIO */
405 * This section is just to make sure these functions get pulled in from
409 #undef PerlIO_tmpfile
421 * Force this file to be included in perl binary. Which allows this
422 * file to force inclusion of other functions that may be required by
423 * loadable extensions e.g. for FileHandle::tmpfile
427 * Hack sfio does its own 'autoflush' on stdout in common cases. Flush
428 * results in a lot of lseek()s to regular files and lot of small
431 sfset(sfstdout, SF_SHARE, 0);
434 /* This is not the reverse of PerlIO_exportFILE(), PerlIO_releaseFILE() is. */
436 PerlIO_importFILE(FILE *stdio, const char *mode)
438 const int fd = fileno(stdio);
439 if (!mode || !*mode) {
442 return PerlIO_fdopen(fd, mode);
446 PerlIO_findFILE(PerlIO *pio)
448 const int fd = PerlIO_fileno(pio);
449 FILE * const f = fdopen(fd, "r+");
451 if (!f && errno == EINVAL)
453 if (!f && errno == EINVAL)
460 /*======================================================================================*/
462 * Implement all the PerlIO interface ourselves.
468 * We _MUST_ have <unistd.h> if we are using lseek() and may have large
475 #include <sys/mman.h>
479 PerlIO_debug(const char *fmt, ...)
484 if (!PL_perlio_debug_fd) {
485 if (!PL_tainting && PL_uid == PL_euid && PL_gid == PL_egid) {
486 const char * const s = PerlEnv_getenv("PERLIO_DEBUG");
489 = PerlLIO_open3(s, O_WRONLY | O_CREAT | O_APPEND, 0666);
491 PL_perlio_debug_fd = -1;
493 /* tainting or set*id, so ignore the environment, and ensure we
494 skip these tests next time through. */
495 PL_perlio_debug_fd = -1;
498 if (PL_perlio_debug_fd > 0) {
501 const char * const s = CopFILE(PL_curcop);
502 /* Use fixed buffer as sv_catpvf etc. needs SVs */
504 const STRLEN len1 = my_snprintf(buffer, sizeof(buffer), "%.40s:%" IVdf " ", s ? s : "(none)", (IV) CopLINE(PL_curcop));
505 const STRLEN len2 = my_vsnprintf(buffer + len1, sizeof(buffer) - len1, fmt, ap);
506 PerlLIO_write(PL_perlio_debug_fd, buffer, len1 + len2);
508 const char *s = CopFILE(PL_curcop);
510 SV * const sv = newSVpvs("");
511 Perl_sv_catpvf(aTHX_ sv, "%s:%" IVdf " ", s ? s : "(none)",
512 (IV) CopLINE(PL_curcop));
513 Perl_sv_vcatpvf(aTHX_ sv, fmt, &ap);
515 s = SvPV_const(sv, len);
516 PerlLIO_write(PL_perlio_debug_fd, s, len);
523 /*--------------------------------------------------------------------------------------*/
526 * Inner level routines
530 * Table of pointers to the PerlIO structs (malloc'ed)
532 #define PERLIO_TABLE_SIZE 64
535 PerlIO_allocate(pTHX)
539 * Find a free slot in the table, allocating new table as necessary
544 while ((f = *last)) {
546 last = (PerlIO **) (f);
547 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
553 Newxz(f,PERLIO_TABLE_SIZE,PerlIO);
561 #undef PerlIO_fdupopen
563 PerlIO_fdupopen(pTHX_ PerlIO *f, CLONE_PARAMS *param, int flags)
565 if (PerlIOValid(f)) {
566 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;
567 PerlIO_debug("fdupopen f=%p param=%p\n",(void*)f,(void*)param);
569 return (*tab->Dup)(aTHX_ PerlIO_allocate(aTHX), f, param, flags);
571 return PerlIOBase_dup(aTHX_ PerlIO_allocate(aTHX), f, param, flags);
575 SETERRNO(EBADF, SS_IVCHAN);
581 PerlIO_cleantable(pTHX_ PerlIO **tablep)
583 PerlIO * const table = *tablep;
586 PerlIO_cleantable(aTHX_(PerlIO **) & (table[0]));
587 for (i = PERLIO_TABLE_SIZE - 1; i > 0; i--) {
588 PerlIO * const f = table + i;
600 PerlIO_list_alloc(pTHX)
604 Newxz(list, 1, PerlIO_list_t);
610 PerlIO_list_free(pTHX_ PerlIO_list_t *list)
613 if (--list->refcnt == 0) {
616 for (i = 0; i < list->cur; i++) {
617 if (list->array[i].arg)
618 SvREFCNT_dec(list->array[i].arg);
620 Safefree(list->array);
628 PerlIO_list_push(pTHX_ PerlIO_list_t *list, PerlIO_funcs *funcs, SV *arg)
634 if (list->cur >= list->len) {
637 Renew(list->array, list->len, PerlIO_pair_t);
639 Newx(list->array, list->len, PerlIO_pair_t);
641 p = &(list->array[list->cur++]);
643 if ((p->arg = arg)) {
644 SvREFCNT_inc_simple_void_NN(arg);
649 PerlIO_clone_list(pTHX_ PerlIO_list_t *proto, CLONE_PARAMS *param)
651 PerlIO_list_t *list = NULL;
654 list = PerlIO_list_alloc(aTHX);
655 for (i=0; i < proto->cur; i++) {
656 SV *arg = proto->array[i].arg;
659 arg = sv_dup(arg, param);
661 PERL_UNUSED_ARG(param);
663 PerlIO_list_push(aTHX_ list, proto->array[i].funcs, arg);
670 PerlIO_clone(pTHX_ PerlInterpreter *proto, CLONE_PARAMS *param)
673 PerlIO **table = &proto->Iperlio;
676 PL_known_layers = PerlIO_clone_list(aTHX_ proto->Iknown_layers, param);
677 PL_def_layerlist = PerlIO_clone_list(aTHX_ proto->Idef_layerlist, param);
678 PerlIO_allocate(aTHX); /* root slot is never used */
679 PerlIO_debug("Clone %p from %p\n",(void*)aTHX,(void*)proto);
680 while ((f = *table)) {
682 table = (PerlIO **) (f++);
683 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
685 (void) fp_dup(f, 0, param);
692 PERL_UNUSED_ARG(proto);
693 PERL_UNUSED_ARG(param);
698 PerlIO_destruct(pTHX)
701 PerlIO **table = &PL_perlio;
704 PerlIO_debug("Destruct %p\n",(void*)aTHX);
706 while ((f = *table)) {
708 table = (PerlIO **) (f++);
709 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
713 if (l->tab->kind & PERLIO_K_DESTRUCT) {
714 PerlIO_debug("Destruct popping %s\n", l->tab->name);
728 PerlIO_pop(pTHX_ PerlIO *f)
730 const PerlIOl *l = *f;
732 PerlIO_debug("PerlIO_pop f=%p %s\n", (void*)f, l->tab->name);
733 if (l->tab->Popped) {
735 * If popped returns non-zero do not free its layer structure
736 * it has either done so itself, or it is shared and still in
739 if ((*l->tab->Popped) (aTHX_ f) != 0)
747 /* Return as an array the stack of layers on a filehandle. Note that
748 * the stack is returned top-first in the array, and there are three
749 * times as many array elements as there are layers in the stack: the
750 * first element of a layer triplet is the name, the second one is the
751 * arguments, and the third one is the flags. */
754 PerlIO_get_layers(pTHX_ PerlIO *f)
757 AV * const av = newAV();
759 if (PerlIOValid(f)) {
760 PerlIOl *l = PerlIOBase(f);
763 SV * const name = l->tab && l->tab->name ?
764 newSVpv(l->tab->name, 0) : &PL_sv_undef;
765 SV * const arg = l->tab && l->tab->Getarg ?
766 (*l->tab->Getarg)(aTHX_ &l, 0, 0) : &PL_sv_undef;
769 av_push(av, newSViv((IV)l->flags));
777 /*--------------------------------------------------------------------------------------*/
779 * XS Interface for perl code
783 PerlIO_find_layer(pTHX_ const char *name, STRLEN len, int load)
787 if ((SSize_t) len <= 0)
789 for (i = 0; i < PL_known_layers->cur; i++) {
790 PerlIO_funcs * const f = PL_known_layers->array[i].funcs;
791 if (memEQ(f->name, name, len) && f->name[len] == 0) {
792 PerlIO_debug("%.*s => %p\n", (int) len, name, (void*)f);
796 if (load && PL_subname && PL_def_layerlist
797 && PL_def_layerlist->cur >= 2) {
798 if (PL_in_load_module) {
799 Perl_croak(aTHX_ "Recursive call to Perl_load_module in PerlIO_find_layer");
802 SV * const pkgsv = newSVpvs("PerlIO");
803 SV * const layer = newSVpvn(name, len);
804 CV * const cv = Perl_get_cvn_flags(aTHX_ STR_WITH_LEN("PerlIO::Layer::NoWarnings"), 0);
806 SAVEINT(PL_in_load_module);
808 SAVEGENERICSV(PL_warnhook);
809 PL_warnhook = (SV *) (SvREFCNT_inc_simple_NN(cv));
813 * The two SVs are magically freed by load_module
815 Perl_load_module(aTHX_ 0, pkgsv, NULL, layer, NULL);
818 return PerlIO_find_layer(aTHX_ name, len, 0);
821 PerlIO_debug("Cannot find %.*s\n", (int) len, name);
825 #ifdef USE_ATTRIBUTES_FOR_PERLIO
828 perlio_mg_set(pTHX_ SV *sv, MAGIC *mg)
831 IO * const io = GvIOn((GV *) SvRV(sv));
832 PerlIO * const ifp = IoIFP(io);
833 PerlIO * const ofp = IoOFP(io);
834 Perl_warn(aTHX_ "set %" SVf " %p %p %p",
835 SVfARG(sv), (void*)io, (void*)ifp, (void*)ofp);
841 perlio_mg_get(pTHX_ SV *sv, MAGIC *mg)
844 IO * const io = GvIOn((GV *) SvRV(sv));
845 PerlIO * const ifp = IoIFP(io);
846 PerlIO * const ofp = IoOFP(io);
847 Perl_warn(aTHX_ "get %" SVf " %p %p %p",
848 SVfARG(sv), (void*)io, (void*)ifp, (void*)ofp);
854 perlio_mg_clear(pTHX_ SV *sv, MAGIC *mg)
856 Perl_warn(aTHX_ "clear %" SVf, SVfARG(sv));
861 perlio_mg_free(pTHX_ SV *sv, MAGIC *mg)
863 Perl_warn(aTHX_ "free %" SVf, SVfARG(sv));
867 MGVTBL perlio_vtab = {
875 XS(XS_io_MODIFY_SCALAR_ATTRIBUTES)
878 SV * const sv = SvRV(ST(1));
879 AV * const av = newAV();
883 sv_magic(sv, (SV *) av, PERL_MAGIC_ext, NULL, 0);
885 mg = mg_find(sv, PERL_MAGIC_ext);
886 mg->mg_virtual = &perlio_vtab;
888 Perl_warn(aTHX_ "attrib %" SVf, SVfARG(sv));
889 for (i = 2; i < items; i++) {
891 const char * const name = SvPV_const(ST(i), len);
892 SV * const layer = PerlIO_find_layer(aTHX_ name, len, 1);
894 av_push(av, SvREFCNT_inc_simple_NN(layer));
905 #endif /* USE_ATTIBUTES_FOR_PERLIO */
908 PerlIO_tab_sv(pTHX_ PerlIO_funcs *tab)
910 HV * const stash = gv_stashpvs("PerlIO::Layer", GV_ADD);
911 SV * const sv = sv_bless(newRV_noinc(newSViv(PTR2IV(tab))), stash);
915 XS(XS_PerlIO__Layer__NoWarnings)
917 /* This is used as a %SIG{__WARN__} handler to supress warnings
918 during loading of layers.
924 PerlIO_debug("warning:%s\n",SvPV_nolen_const(ST(0)));
928 XS(XS_PerlIO__Layer__find)
934 Perl_croak(aTHX_ "Usage class->find(name[,load])");
937 const char * const name = SvPV_const(ST(1), len);
938 const bool load = (items > 2) ? SvTRUE(ST(2)) : 0;
939 PerlIO_funcs * const layer = PerlIO_find_layer(aTHX_ name, len, load);
941 (layer) ? sv_2mortal(PerlIO_tab_sv(aTHX_ layer)) :
948 PerlIO_define_layer(pTHX_ PerlIO_funcs *tab)
951 if (!PL_known_layers)
952 PL_known_layers = PerlIO_list_alloc(aTHX);
953 PerlIO_list_push(aTHX_ PL_known_layers, tab, NULL);
954 PerlIO_debug("define %s %p\n", tab->name, (void*)tab);
958 PerlIO_parse_layers(pTHX_ PerlIO_list_t *av, const char *names)
962 const char *s = names;
964 while (isSPACE(*s) || *s == ':')
969 const char *as = NULL;
971 if (!isIDFIRST(*s)) {
973 * Message is consistent with how attribute lists are
974 * passed. Even though this means "foo : : bar" is
975 * seen as an invalid separator character.
977 const char q = ((*s == '\'') ? '"' : '\'');
978 if (ckWARN(WARN_LAYER))
979 Perl_warner(aTHX_ packWARN(WARN_LAYER),
980 "Invalid separator character %c%c%c in PerlIO layer specification %s",
982 SETERRNO(EINVAL, LIB_INVARG);
987 } while (isALNUM(*e));
1003 * It's a nul terminated string, not allowed
1004 * to \ the terminating null. Anything other
1005 * character is passed over.
1015 if (ckWARN(WARN_LAYER))
1016 Perl_warner(aTHX_ packWARN(WARN_LAYER),
1017 "Argument list not closed for PerlIO layer \"%.*s\"",
1029 PerlIO_funcs * const layer =
1030 PerlIO_find_layer(aTHX_ s, llen, 1);
1034 arg = newSVpvn(as, alen);
1035 PerlIO_list_push(aTHX_ av, layer,
1036 (arg) ? arg : &PL_sv_undef);
1041 if (ckWARN(WARN_LAYER))
1042 Perl_warner(aTHX_ packWARN(WARN_LAYER), "Unknown PerlIO layer \"%.*s\"",
1055 PerlIO_default_buffer(pTHX_ PerlIO_list_t *av)
1058 PERLIO_FUNCS_DECL(*tab) = &PerlIO_perlio;
1059 #ifdef PERLIO_USING_CRLF
1062 if (PerlIO_stdio.Set_ptrcnt)
1063 tab = &PerlIO_stdio;
1065 PerlIO_debug("Pushing %s\n", tab->name);
1066 PerlIO_list_push(aTHX_ av, PerlIO_find_layer(aTHX_ tab->name, 0, 0),
1071 PerlIO_arg_fetch(PerlIO_list_t *av, IV n)
1073 return av->array[n].arg;
1077 PerlIO_layer_fetch(pTHX_ PerlIO_list_t *av, IV n, PerlIO_funcs *def)
1079 if (n >= 0 && n < av->cur) {
1080 PerlIO_debug("Layer %" IVdf " is %s\n", n,
1081 av->array[n].funcs->name);
1082 return av->array[n].funcs;
1085 Perl_croak(aTHX_ "panic: PerlIO layer array corrupt");
1090 PerlIOPop_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1092 PERL_UNUSED_ARG(mode);
1093 PERL_UNUSED_ARG(arg);
1094 PERL_UNUSED_ARG(tab);
1095 if (PerlIOValid(f)) {
1097 PerlIO_pop(aTHX_ f);
1103 PERLIO_FUNCS_DECL(PerlIO_remove) = {
1104 sizeof(PerlIO_funcs),
1107 PERLIO_K_DUMMY | PERLIO_K_UTF8,
1127 NULL, /* get_base */
1128 NULL, /* get_bufsiz */
1131 NULL, /* set_ptrcnt */
1135 PerlIO_default_layers(pTHX)
1138 if (!PL_def_layerlist) {
1139 const char * const s = (PL_tainting) ? NULL : PerlEnv_getenv("PERLIO");
1140 PERLIO_FUNCS_DECL(*osLayer) = &PerlIO_unix;
1141 PL_def_layerlist = PerlIO_list_alloc(aTHX);
1142 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_unix));
1144 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_win32));
1146 osLayer = &PerlIO_win32;
1149 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_raw));
1150 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_perlio));
1151 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_stdio));
1152 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_crlf));
1154 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_mmap));
1156 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_utf8));
1157 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_remove));
1158 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_byte));
1159 PerlIO_list_push(aTHX_ PL_def_layerlist,
1160 PerlIO_find_layer(aTHX_ osLayer->name, 0, 0),
1163 PerlIO_parse_layers(aTHX_ PL_def_layerlist, s);
1166 PerlIO_default_buffer(aTHX_ PL_def_layerlist);
1169 if (PL_def_layerlist->cur < 2) {
1170 PerlIO_default_buffer(aTHX_ PL_def_layerlist);
1172 return PL_def_layerlist;
1176 Perl_boot_core_PerlIO(pTHX)
1178 #ifdef USE_ATTRIBUTES_FOR_PERLIO
1179 newXS("io::MODIFY_SCALAR_ATTRIBUTES", XS_io_MODIFY_SCALAR_ATTRIBUTES,
1182 newXS("PerlIO::Layer::find", XS_PerlIO__Layer__find, __FILE__);
1183 newXS("PerlIO::Layer::NoWarnings", XS_PerlIO__Layer__NoWarnings, __FILE__);
1187 PerlIO_default_layer(pTHX_ I32 n)
1190 PerlIO_list_t * const av = PerlIO_default_layers(aTHX);
1193 return PerlIO_layer_fetch(aTHX_ av, n, PERLIO_FUNCS_CAST(&PerlIO_stdio));
1196 #define PerlIO_default_top() PerlIO_default_layer(aTHX_ -1)
1197 #define PerlIO_default_btm() PerlIO_default_layer(aTHX_ 0)
1200 PerlIO_stdstreams(pTHX)
1204 PerlIO_allocate(aTHX);
1205 PerlIO_fdopen(0, "Ir" PERLIO_STDTEXT);
1206 PerlIO_fdopen(1, "Iw" PERLIO_STDTEXT);
1207 PerlIO_fdopen(2, "Iw" PERLIO_STDTEXT);
1212 PerlIO_push(pTHX_ PerlIO *f, PERLIO_FUNCS_DECL(*tab), const char *mode, SV *arg)
1214 if (tab->fsize != sizeof(PerlIO_funcs)) {
1216 Perl_croak(aTHX_ "Layer does not match this perl");
1220 if (tab->size < sizeof(PerlIOl)) {
1223 /* Real layer with a data area */
1226 Newxz(temp, tab->size, char);
1230 l->tab = (PerlIO_funcs*) tab;
1232 PerlIO_debug("PerlIO_push f=%p %s %s %p\n",
1233 (void*)f, tab->name,
1234 (mode) ? mode : "(Null)", (void*)arg);
1235 if (*l->tab->Pushed &&
1237 (aTHX_ f, mode, arg, (PerlIO_funcs*) tab) != 0) {
1238 PerlIO_pop(aTHX_ f);
1247 /* Pseudo-layer where push does its own stack adjust */
1248 PerlIO_debug("PerlIO_push f=%p %s %s %p\n", (void*)f, tab->name,
1249 (mode) ? mode : "(Null)", (void*)arg);
1251 (*tab->Pushed) (aTHX_ f, mode, arg, (PerlIO_funcs*) tab) != 0) {
1259 PerlIOBase_binmode(pTHX_ PerlIO *f)
1261 if (PerlIOValid(f)) {
1262 /* Is layer suitable for raw stream ? */
1263 if (PerlIOBase(f)->tab->kind & PERLIO_K_RAW) {
1264 /* Yes - turn off UTF-8-ness, to undo UTF-8 locale effects */
1265 PerlIOBase(f)->flags &= ~PERLIO_F_UTF8;
1268 /* Not suitable - pop it */
1269 PerlIO_pop(aTHX_ f);
1277 PerlIORaw_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1279 PERL_UNUSED_ARG(mode);
1280 PERL_UNUSED_ARG(arg);
1281 PERL_UNUSED_ARG(tab);
1283 if (PerlIOValid(f)) {
1288 * Strip all layers that are not suitable for a raw stream
1291 while (t && (l = *t)) {
1292 if (l->tab->Binmode) {
1293 /* Has a handler - normal case */
1294 if ((*l->tab->Binmode)(aTHX_ f) == 0) {
1296 /* Layer still there - move down a layer */
1305 /* No handler - pop it */
1306 PerlIO_pop(aTHX_ t);
1309 if (PerlIOValid(f)) {
1310 PerlIO_debug(":raw f=%p :%s\n", (void*)f, PerlIOBase(f)->tab->name);
1318 PerlIO_apply_layera(pTHX_ PerlIO *f, const char *mode,
1319 PerlIO_list_t *layers, IV n, IV max)
1323 PerlIO_funcs * const tab = PerlIO_layer_fetch(aTHX_ layers, n, NULL);
1325 if (!PerlIO_push(aTHX_ f, tab, mode, PerlIOArg)) {
1336 PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode, const char *names)
1340 PerlIO_list_t * const layers = PerlIO_list_alloc(aTHX);
1341 code = PerlIO_parse_layers(aTHX_ layers, names);
1343 code = PerlIO_apply_layera(aTHX_ f, mode, layers, 0, layers->cur);
1345 PerlIO_list_free(aTHX_ layers);
1351 /*--------------------------------------------------------------------------------------*/
1353 * Given the abstraction above the public API functions
1357 PerlIO_binmode(pTHX_ PerlIO *f, int iotype, int mode, const char *names)
1359 PerlIO_debug("PerlIO_binmode f=%p %s %c %x %s\n", (void*)f,
1360 (PerlIOBase(f)) ? PerlIOBase(f)->tab->name : "(Null)",
1361 iotype, mode, (names) ? names : "(Null)");
1364 /* Do not flush etc. if (e.g.) switching encodings.
1365 if a pushed layer knows it needs to flush lower layers
1366 (for example :unix which is never going to call them)
1367 it can do the flush when it is pushed.
1369 return PerlIO_apply_layers(aTHX_ f, NULL, names) == 0 ? TRUE : FALSE;
1372 /* Fake 5.6 legacy of using this call to turn ON O_TEXT */
1373 #ifdef PERLIO_USING_CRLF
1374 /* Legacy binmode only has meaning if O_TEXT has a value distinct from
1375 O_BINARY so we can look for it in mode.
1377 if (!(mode & O_BINARY)) {
1379 /* FIXME?: Looking down the layer stack seems wrong,
1380 but is a way of reaching past (say) an encoding layer
1381 to flip CRLF-ness of the layer(s) below
1384 /* Perhaps we should turn on bottom-most aware layer
1385 e.g. Ilya's idea that UNIX TTY could serve
1387 if (PerlIOBase(f)->tab->kind & PERLIO_K_CANCRLF) {
1388 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF)) {
1389 /* Not in text mode - flush any pending stuff and flip it */
1391 PerlIOBase(f)->flags |= PERLIO_F_CRLF;
1393 /* Only need to turn it on in one layer so we are done */
1398 /* Not finding a CRLF aware layer presumably means we are binary
1399 which is not what was requested - so we failed
1400 We _could_ push :crlf layer but so could caller
1405 /* Legacy binmode is now _defined_ as being equivalent to pushing :raw
1406 So code that used to be here is now in PerlIORaw_pushed().
1408 return PerlIO_push(aTHX_ f, PERLIO_FUNCS_CAST(&PerlIO_raw), NULL, NULL) ? TRUE : FALSE;
1413 PerlIO__close(pTHX_ PerlIO *f)
1415 if (PerlIOValid(f)) {
1416 PerlIO_funcs * const tab = PerlIOBase(f)->tab;
1417 if (tab && tab->Close)
1418 return (*tab->Close)(aTHX_ f);
1420 return PerlIOBase_close(aTHX_ f);
1423 SETERRNO(EBADF, SS_IVCHAN);
1429 Perl_PerlIO_close(pTHX_ PerlIO *f)
1431 const int code = PerlIO__close(aTHX_ f);
1432 while (PerlIOValid(f)) {
1433 PerlIO_pop(aTHX_ f);
1439 Perl_PerlIO_fileno(pTHX_ PerlIO *f)
1442 Perl_PerlIO_or_Base(f, Fileno, fileno, -1, (aTHX_ f));
1446 static PerlIO_funcs *
1447 PerlIO_layer_from_ref(pTHX_ SV *sv)
1451 * For any scalar type load the handler which is bundled with perl
1453 if (SvTYPE(sv) < SVt_PVAV) {
1454 PerlIO_funcs *f = PerlIO_find_layer(aTHX_ STR_WITH_LEN("scalar"), 1);
1455 /* This isn't supposed to happen, since PerlIO::scalar is core,
1456 * but could happen anyway in smaller installs or with PAR */
1457 if (!f && ckWARN(WARN_LAYER))
1458 Perl_warner(aTHX_ packWARN(WARN_LAYER), "Unknown PerlIO layer \"scalar\"");
1463 * For other types allow if layer is known but don't try and load it
1465 switch (SvTYPE(sv)) {
1467 return PerlIO_find_layer(aTHX_ STR_WITH_LEN("Array"), 0);
1469 return PerlIO_find_layer(aTHX_ STR_WITH_LEN("Hash"), 0);
1471 return PerlIO_find_layer(aTHX_ STR_WITH_LEN("Code"), 0);
1473 return PerlIO_find_layer(aTHX_ STR_WITH_LEN("Glob"), 0);
1480 PerlIO_resolve_layers(pTHX_ const char *layers,
1481 const char *mode, int narg, SV **args)
1484 PerlIO_list_t *def = PerlIO_default_layers(aTHX);
1487 PerlIO_stdstreams(aTHX);
1489 SV * const arg = *args;
1491 * If it is a reference but not an object see if we have a handler
1494 if (SvROK(arg) && !sv_isobject(arg)) {
1495 PerlIO_funcs * const handler = PerlIO_layer_from_ref(aTHX_ SvRV(arg));
1497 def = PerlIO_list_alloc(aTHX);
1498 PerlIO_list_push(aTHX_ def, handler, &PL_sv_undef);
1502 * Don't fail if handler cannot be found :via(...) etc. may do
1503 * something sensible else we will just stringfy and open
1508 if (!layers || !*layers)
1509 layers = Perl_PerlIO_context_layers(aTHX_ mode);
1510 if (layers && *layers) {
1513 av = PerlIO_clone_list(aTHX_ def, NULL);
1518 if (PerlIO_parse_layers(aTHX_ av, layers) == 0) {
1522 PerlIO_list_free(aTHX_ av);
1534 PerlIO_openn(pTHX_ const char *layers, const char *mode, int fd,
1535 int imode, int perm, PerlIO *f, int narg, SV **args)
1538 if (!f && narg == 1 && *args == &PL_sv_undef) {
1539 if ((f = PerlIO_tmpfile())) {
1540 if (!layers || !*layers)
1541 layers = Perl_PerlIO_context_layers(aTHX_ mode);
1542 if (layers && *layers)
1543 PerlIO_apply_layers(aTHX_ f, mode, layers);
1547 PerlIO_list_t *layera;
1549 PerlIO_funcs *tab = NULL;
1550 if (PerlIOValid(f)) {
1552 * This is "reopen" - it is not tested as perl does not use it
1556 layera = PerlIO_list_alloc(aTHX);
1560 arg = (*l->tab->Getarg) (aTHX_ &l, NULL, 0);
1561 PerlIO_list_push(aTHX_ layera, l->tab,
1562 (arg) ? arg : &PL_sv_undef);
1565 l = *PerlIONext(&l);
1569 layera = PerlIO_resolve_layers(aTHX_ layers, mode, narg, args);
1575 * Start at "top" of layer stack
1577 n = layera->cur - 1;
1579 PerlIO_funcs * const t = PerlIO_layer_fetch(aTHX_ layera, n, NULL);
1588 * Found that layer 'n' can do opens - call it
1590 if (narg > 1 && !(tab->kind & PERLIO_K_MULTIARG)) {
1591 Perl_croak(aTHX_ "More than one argument to open(,':%s')",tab->name);
1593 PerlIO_debug("openn(%s,'%s','%s',%d,%x,%o,%p,%d,%p)\n",
1594 tab->name, layers ? layers : "(Null)", mode, fd,
1595 imode, perm, (void*)f, narg, (void*)args);
1597 f = (*tab->Open) (aTHX_ tab, layera, n, mode, fd, imode, perm,
1600 SETERRNO(EINVAL, LIB_INVARG);
1604 if (n + 1 < layera->cur) {
1606 * More layers above the one that we used to open -
1609 if (PerlIO_apply_layera(aTHX_ f, mode, layera, n + 1, layera->cur) != 0) {
1610 /* If pushing layers fails close the file */
1617 PerlIO_list_free(aTHX_ layera);
1624 Perl_PerlIO_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
1626 Perl_PerlIO_or_Base(f, Read, read, -1, (aTHX_ f, vbuf, count));
1630 Perl_PerlIO_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
1632 Perl_PerlIO_or_Base(f, Unread, unread, -1, (aTHX_ f, vbuf, count));
1636 Perl_PerlIO_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
1638 Perl_PerlIO_or_fail(f, Write, -1, (aTHX_ f, vbuf, count));
1642 Perl_PerlIO_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
1644 Perl_PerlIO_or_fail(f, Seek, -1, (aTHX_ f, offset, whence));
1648 Perl_PerlIO_tell(pTHX_ PerlIO *f)
1650 Perl_PerlIO_or_fail(f, Tell, -1, (aTHX_ f));
1654 Perl_PerlIO_flush(pTHX_ PerlIO *f)
1659 const PerlIO_funcs *tab = PerlIOBase(f)->tab;
1661 if (tab && tab->Flush)
1662 return (*tab->Flush) (aTHX_ f);
1664 return 0; /* If no Flush defined, silently succeed. */
1667 PerlIO_debug("Cannot flush f=%p\n", (void*)f);
1668 SETERRNO(EBADF, SS_IVCHAN);
1674 * Is it good API design to do flush-all on NULL, a potentially
1675 * errorneous input? Maybe some magical value (PerlIO*
1676 * PERLIO_FLUSH_ALL = (PerlIO*)-1;)? Yes, stdio does similar
1677 * things on fflush(NULL), but should we be bound by their design
1680 PerlIO **table = &PL_perlio;
1682 while ((f = *table)) {
1684 table = (PerlIO **) (f++);
1685 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
1686 if (*f && PerlIO_flush(f) != 0)
1696 PerlIOBase_flush_linebuf(pTHX)
1699 PerlIO **table = &PL_perlio;
1701 while ((f = *table)) {
1703 table = (PerlIO **) (f++);
1704 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
1707 flags & (PERLIO_F_LINEBUF | PERLIO_F_CANWRITE))
1708 == (PERLIO_F_LINEBUF | PERLIO_F_CANWRITE))
1716 Perl_PerlIO_fill(pTHX_ PerlIO *f)
1718 Perl_PerlIO_or_fail(f, Fill, -1, (aTHX_ f));
1722 PerlIO_isutf8(PerlIO *f)
1725 return (PerlIOBase(f)->flags & PERLIO_F_UTF8) != 0;
1727 SETERRNO(EBADF, SS_IVCHAN);
1733 Perl_PerlIO_eof(pTHX_ PerlIO *f)
1735 Perl_PerlIO_or_Base(f, Eof, eof, -1, (aTHX_ f));
1739 Perl_PerlIO_error(pTHX_ PerlIO *f)
1741 Perl_PerlIO_or_Base(f, Error, error, -1, (aTHX_ f));
1745 Perl_PerlIO_clearerr(pTHX_ PerlIO *f)
1747 Perl_PerlIO_or_Base_void(f, Clearerr, clearerr, (aTHX_ f));
1751 Perl_PerlIO_setlinebuf(pTHX_ PerlIO *f)
1753 Perl_PerlIO_or_Base_void(f, Setlinebuf, setlinebuf, (aTHX_ f));
1757 PerlIO_has_base(PerlIO *f)
1759 if (PerlIOValid(f)) {
1760 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;
1763 return (tab->Get_base != NULL);
1764 SETERRNO(EINVAL, LIB_INVARG);
1767 SETERRNO(EBADF, SS_IVCHAN);
1773 PerlIO_fast_gets(PerlIO *f)
1775 if (PerlIOValid(f) && (PerlIOBase(f)->flags & PERLIO_F_FASTGETS)) {
1776 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;
1779 return (tab->Set_ptrcnt != NULL);
1780 SETERRNO(EINVAL, LIB_INVARG);
1783 SETERRNO(EBADF, SS_IVCHAN);
1789 PerlIO_has_cntptr(PerlIO *f)
1791 if (PerlIOValid(f)) {
1792 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;
1795 return (tab->Get_ptr != NULL && tab->Get_cnt != NULL);
1796 SETERRNO(EINVAL, LIB_INVARG);
1799 SETERRNO(EBADF, SS_IVCHAN);
1805 PerlIO_canset_cnt(PerlIO *f)
1807 if (PerlIOValid(f)) {
1808 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;
1811 return (tab->Set_ptrcnt != NULL);
1812 SETERRNO(EINVAL, LIB_INVARG);
1815 SETERRNO(EBADF, SS_IVCHAN);
1821 Perl_PerlIO_get_base(pTHX_ PerlIO *f)
1823 Perl_PerlIO_or_fail(f, Get_base, NULL, (aTHX_ f));
1827 Perl_PerlIO_get_bufsiz(pTHX_ PerlIO *f)
1829 Perl_PerlIO_or_fail(f, Get_bufsiz, -1, (aTHX_ f));
1833 Perl_PerlIO_get_ptr(pTHX_ PerlIO *f)
1835 Perl_PerlIO_or_fail(f, Get_ptr, NULL, (aTHX_ f));
1839 Perl_PerlIO_get_cnt(pTHX_ PerlIO *f)
1841 Perl_PerlIO_or_fail(f, Get_cnt, -1, (aTHX_ f));
1845 Perl_PerlIO_set_cnt(pTHX_ PerlIO *f, int cnt)
1847 Perl_PerlIO_or_fail_void(f, Set_ptrcnt, (aTHX_ f, NULL, cnt));
1851 Perl_PerlIO_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, int cnt)
1853 Perl_PerlIO_or_fail_void(f, Set_ptrcnt, (aTHX_ f, ptr, cnt));
1857 /*--------------------------------------------------------------------------------------*/
1859 * utf8 and raw dummy layers
1863 PerlIOUtf8_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1865 PERL_UNUSED_CONTEXT;
1866 PERL_UNUSED_ARG(mode);
1867 PERL_UNUSED_ARG(arg);
1868 if (PerlIOValid(f)) {
1869 if (tab->kind & PERLIO_K_UTF8)
1870 PerlIOBase(f)->flags |= PERLIO_F_UTF8;
1872 PerlIOBase(f)->flags &= ~PERLIO_F_UTF8;
1878 PERLIO_FUNCS_DECL(PerlIO_utf8) = {
1879 sizeof(PerlIO_funcs),
1882 PERLIO_K_DUMMY | PERLIO_K_UTF8,
1902 NULL, /* get_base */
1903 NULL, /* get_bufsiz */
1906 NULL, /* set_ptrcnt */
1909 PERLIO_FUNCS_DECL(PerlIO_byte) = {
1910 sizeof(PerlIO_funcs),
1933 NULL, /* get_base */
1934 NULL, /* get_bufsiz */
1937 NULL, /* set_ptrcnt */
1941 PerlIORaw_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
1942 IV n, const char *mode, int fd, int imode, int perm,
1943 PerlIO *old, int narg, SV **args)
1945 PerlIO_funcs * const tab = PerlIO_default_btm();
1946 PERL_UNUSED_ARG(self);
1947 if (tab && tab->Open)
1948 return (*tab->Open) (aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
1950 SETERRNO(EINVAL, LIB_INVARG);
1954 PERLIO_FUNCS_DECL(PerlIO_raw) = {
1955 sizeof(PerlIO_funcs),
1978 NULL, /* get_base */
1979 NULL, /* get_bufsiz */
1982 NULL, /* set_ptrcnt */
1984 /*--------------------------------------------------------------------------------------*/
1985 /*--------------------------------------------------------------------------------------*/
1987 * "Methods" of the "base class"
1991 PerlIOBase_fileno(pTHX_ PerlIO *f)
1993 return PerlIOValid(f) ? PerlIO_fileno(PerlIONext(f)) : -1;
1997 PerlIO_modestr(PerlIO * f, char *buf)
2000 if (PerlIOValid(f)) {
2001 const IV flags = PerlIOBase(f)->flags;
2002 if (flags & PERLIO_F_APPEND) {
2004 if (flags & PERLIO_F_CANREAD) {
2008 else if (flags & PERLIO_F_CANREAD) {
2010 if (flags & PERLIO_F_CANWRITE)
2013 else if (flags & PERLIO_F_CANWRITE) {
2015 if (flags & PERLIO_F_CANREAD) {
2019 #ifdef PERLIO_USING_CRLF
2020 if (!(flags & PERLIO_F_CRLF))
2030 PerlIOBase_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2032 PerlIOl * const l = PerlIOBase(f);
2033 PERL_UNUSED_CONTEXT;
2034 PERL_UNUSED_ARG(arg);
2036 l->flags &= ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE |
2037 PERLIO_F_TRUNCATE | PERLIO_F_APPEND);
2038 if (tab->Set_ptrcnt != NULL)
2039 l->flags |= PERLIO_F_FASTGETS;
2041 if (*mode == IoTYPE_NUMERIC || *mode == IoTYPE_IMPLICIT)
2045 l->flags |= PERLIO_F_CANREAD;
2048 l->flags |= PERLIO_F_APPEND | PERLIO_F_CANWRITE;
2051 l->flags |= PERLIO_F_TRUNCATE | PERLIO_F_CANWRITE;
2054 SETERRNO(EINVAL, LIB_INVARG);
2060 l->flags |= PERLIO_F_CANREAD | PERLIO_F_CANWRITE;
2063 l->flags &= ~PERLIO_F_CRLF;
2066 l->flags |= PERLIO_F_CRLF;
2069 SETERRNO(EINVAL, LIB_INVARG);
2076 l->flags |= l->next->flags &
2077 (PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_TRUNCATE |
2082 PerlIO_debug("PerlIOBase_pushed f=%p %s %s fl=%08" UVxf " (%s)\n",
2083 (void*)f, PerlIOBase(f)->tab->name, (omode) ? omode : "(Null)",
2084 l->flags, PerlIO_modestr(f, temp));
2090 PerlIOBase_popped(pTHX_ PerlIO *f)
2092 PERL_UNUSED_CONTEXT;
2098 PerlIOBase_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
2101 * Save the position as current head considers it
2103 const Off_t old = PerlIO_tell(f);
2104 PerlIO_push(aTHX_ f, PERLIO_FUNCS_CAST(&PerlIO_pending), "r", NULL);
2105 PerlIOSelf(f, PerlIOBuf)->posn = old;
2106 return PerlIOBuf_unread(aTHX_ f, vbuf, count);
2110 PerlIOBase_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
2112 STDCHAR *buf = (STDCHAR *) vbuf;
2114 if (!(PerlIOBase(f)->flags & PERLIO_F_CANREAD)) {
2115 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2116 SETERRNO(EBADF, SS_IVCHAN);
2122 SSize_t avail = PerlIO_get_cnt(f);
2125 take = ((SSize_t)count < avail) ? (SSize_t)count : avail;
2127 STDCHAR *ptr = PerlIO_get_ptr(f);
2128 Copy(ptr, buf, take, STDCHAR);
2129 PerlIO_set_ptrcnt(f, ptr + take, (avail -= take));
2132 if (avail == 0) /* set_ptrcnt could have reset avail */
2135 if (count > 0 && avail <= 0) {
2136 if (PerlIO_fill(f) != 0)
2141 return (buf - (STDCHAR *) vbuf);
2147 PerlIOBase_noop_ok(pTHX_ PerlIO *f)
2149 PERL_UNUSED_CONTEXT;
2155 PerlIOBase_noop_fail(pTHX_ PerlIO *f)
2157 PERL_UNUSED_CONTEXT;
2163 PerlIOBase_close(pTHX_ PerlIO *f)
2166 if (PerlIOValid(f)) {
2167 PerlIO *n = PerlIONext(f);
2168 code = PerlIO_flush(f);
2169 PerlIOBase(f)->flags &=
2170 ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_OPEN);
2171 while (PerlIOValid(n)) {
2172 const PerlIO_funcs * const tab = PerlIOBase(n)->tab;
2173 if (tab && tab->Close) {
2174 if ((*tab->Close)(aTHX_ n) != 0)
2179 PerlIOBase(n)->flags &=
2180 ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_OPEN);
2186 SETERRNO(EBADF, SS_IVCHAN);
2192 PerlIOBase_eof(pTHX_ PerlIO *f)
2194 PERL_UNUSED_CONTEXT;
2195 if (PerlIOValid(f)) {
2196 return (PerlIOBase(f)->flags & PERLIO_F_EOF) != 0;
2202 PerlIOBase_error(pTHX_ PerlIO *f)
2204 PERL_UNUSED_CONTEXT;
2205 if (PerlIOValid(f)) {
2206 return (PerlIOBase(f)->flags & PERLIO_F_ERROR) != 0;
2212 PerlIOBase_clearerr(pTHX_ PerlIO *f)
2214 if (PerlIOValid(f)) {
2215 PerlIO * const n = PerlIONext(f);
2216 PerlIOBase(f)->flags &= ~(PERLIO_F_ERROR | PERLIO_F_EOF);
2223 PerlIOBase_setlinebuf(pTHX_ PerlIO *f)
2225 PERL_UNUSED_CONTEXT;
2226 if (PerlIOValid(f)) {
2227 PerlIOBase(f)->flags |= PERLIO_F_LINEBUF;
2232 PerlIO_sv_dup(pTHX_ SV *arg, CLONE_PARAMS *param)
2238 arg = sv_dup(arg, param);
2239 SvREFCNT_inc_simple_void_NN(arg);
2243 return newSVsv(arg);
2246 PERL_UNUSED_ARG(param);
2247 return newSVsv(arg);
2252 PerlIOBase_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2254 PerlIO * const nexto = PerlIONext(o);
2255 if (PerlIOValid(nexto)) {
2256 const PerlIO_funcs * const tab = PerlIOBase(nexto)->tab;
2257 if (tab && tab->Dup)
2258 f = (*tab->Dup)(aTHX_ f, nexto, param, flags);
2260 f = PerlIOBase_dup(aTHX_ f, nexto, param, flags);
2263 PerlIO_funcs * const self = PerlIOBase(o)->tab;
2266 PerlIO_debug("PerlIOBase_dup %s f=%p o=%p param=%p\n",
2267 self->name, (void*)f, (void*)o, (void*)param);
2269 arg = (*self->Getarg)(aTHX_ o, param, flags);
2270 f = PerlIO_push(aTHX_ f, self, PerlIO_modestr(o,buf), arg);
2277 /* PL_perlio_fd_refcnt[] is in intrpvar.h */
2279 /* Must be called with PL_perlio_mutex locked. */
2281 S_more_refcounted_fds(pTHX_ const int new_fd) {
2283 const int old_max = PL_perlio_fd_refcnt_size;
2284 const int new_max = 16 + (new_fd & ~15);
2287 PerlIO_debug("More fds - old=%d, need %d, new=%d\n",
2288 old_max, new_fd, new_max);
2290 if (new_fd < old_max) {
2294 assert (new_max > new_fd);
2296 /* Use plain realloc() since we need this memory to be really
2297 * global and visible to all the interpreters and/or threads. */
2298 new_array = (int*) realloc(PL_perlio_fd_refcnt, new_max * sizeof(int));
2302 MUTEX_UNLOCK(&PL_perlio_mutex);
2304 /* Can't use PerlIO to write as it allocates memory */
2305 PerlLIO_write(PerlIO_fileno(Perl_error_log),
2306 PL_no_mem, strlen(PL_no_mem));
2310 PL_perlio_fd_refcnt_size = new_max;
2311 PL_perlio_fd_refcnt = new_array;
2313 PerlIO_debug("Zeroing %p, %d\n",
2314 (void*)(new_array + old_max),
2317 Zero(new_array + old_max, new_max - old_max, int);
2324 /* MUTEX_INIT(&PL_perlio_mutex) is done in PERL_SYS_INIT3(). */
2325 PERL_UNUSED_CONTEXT;
2329 PerlIOUnix_refcnt_inc(int fd)
2336 MUTEX_LOCK(&PL_perlio_mutex);
2338 if (fd >= PL_perlio_fd_refcnt_size)
2339 S_more_refcounted_fds(aTHX_ fd);
2341 PL_perlio_fd_refcnt[fd]++;
2342 if (PL_perlio_fd_refcnt[fd] <= 0) {
2343 Perl_croak(aTHX_ "refcnt_inc: fd %d: %d <= 0\n",
2344 fd, PL_perlio_fd_refcnt[fd]);
2346 PerlIO_debug("refcnt_inc: fd %d refcnt=%d\n",
2347 fd, PL_perlio_fd_refcnt[fd]);
2350 MUTEX_UNLOCK(&PL_perlio_mutex);
2353 Perl_croak(aTHX_ "refcnt_inc: fd %d < 0\n", fd);
2358 PerlIOUnix_refcnt_dec(int fd)
2365 MUTEX_LOCK(&PL_perlio_mutex);
2367 if (fd >= PL_perlio_fd_refcnt_size) {
2368 Perl_croak(aTHX_ "refcnt_dec: fd %d >= refcnt_size %d\n",
2369 fd, PL_perlio_fd_refcnt_size);
2371 if (PL_perlio_fd_refcnt[fd] <= 0) {
2372 Perl_croak(aTHX_ "refcnt_dec: fd %d: %d <= 0\n",
2373 fd, PL_perlio_fd_refcnt[fd]);
2375 cnt = --PL_perlio_fd_refcnt[fd];
2376 PerlIO_debug("refcnt_dec: fd %d refcnt=%d\n", fd, cnt);
2378 MUTEX_UNLOCK(&PL_perlio_mutex);
2381 Perl_croak(aTHX_ "refcnt_dec: fd %d < 0\n", fd);
2387 PerlIO_cleanup(pTHX)
2392 PerlIO_debug("Cleanup layers for %p\n",(void*)aTHX);
2394 PerlIO_debug("Cleanup layers\n");
2397 /* Raise STDIN..STDERR refcount so we don't close them */
2398 for (i=0; i < 3; i++)
2399 PerlIOUnix_refcnt_inc(i);
2400 PerlIO_cleantable(aTHX_ &PL_perlio);
2401 /* Restore STDIN..STDERR refcount */
2402 for (i=0; i < 3; i++)
2403 PerlIOUnix_refcnt_dec(i);
2405 if (PL_known_layers) {
2406 PerlIO_list_free(aTHX_ PL_known_layers);
2407 PL_known_layers = NULL;
2409 if (PL_def_layerlist) {
2410 PerlIO_list_free(aTHX_ PL_def_layerlist);
2411 PL_def_layerlist = NULL;
2415 void PerlIO_teardown(pTHX) /* Call only from PERL_SYS_TERM(). */
2420 /* By now all filehandles should have been closed, so any
2421 * stray (non-STD-)filehandles indicate *possible* (PerlIO)
2424 for (i = 3; i < PL_perlio_fd_refcnt_size; i++) {
2425 if (PL_perlio_fd_refcnt[i])
2426 PerlIO_debug("PerlIO_cleanup: fd %d refcnt=%d\n",
2427 i, PL_perlio_fd_refcnt[i]);
2431 /* Not bothering with PL_perlio_mutex since by now
2432 * all the interpreters are gone. */
2433 if (PL_perlio_fd_refcnt_size /* Assuming initial size of zero. */
2434 && PL_perlio_fd_refcnt) {
2435 free(PL_perlio_fd_refcnt); /* To match realloc() in S_more_refcounted_fds(). */
2436 PL_perlio_fd_refcnt = NULL;
2437 PL_perlio_fd_refcnt_size = 0;
2441 /*--------------------------------------------------------------------------------------*/
2443 * Bottom-most level for UNIX-like case
2447 struct _PerlIO base; /* The generic part */
2448 int fd; /* UNIX like file descriptor */
2449 int oflags; /* open/fcntl flags */
2453 PerlIOUnix_oflags(const char *mode)
2456 if (*mode == IoTYPE_IMPLICIT || *mode == IoTYPE_NUMERIC)
2461 if (*++mode == '+') {
2468 oflags = O_CREAT | O_TRUNC;
2469 if (*++mode == '+') {
2478 oflags = O_CREAT | O_APPEND;
2479 if (*++mode == '+') {
2492 else if (*mode == 't') {
2494 oflags &= ~O_BINARY;
2498 * Always open in binary mode
2501 if (*mode || oflags == -1) {
2502 SETERRNO(EINVAL, LIB_INVARG);
2509 PerlIOUnix_fileno(pTHX_ PerlIO *f)
2511 PERL_UNUSED_CONTEXT;
2512 return PerlIOSelf(f, PerlIOUnix)->fd;
2516 PerlIOUnix_setfd(pTHX_ PerlIO *f, int fd, int imode)
2518 PerlIOUnix * const s = PerlIOSelf(f, PerlIOUnix);
2521 if (PerlLIO_fstat(fd, &st) == 0) {
2522 if (!S_ISREG(st.st_mode)) {
2523 PerlIO_debug("%d is not regular file\n",fd);
2524 PerlIOBase(f)->flags |= PERLIO_F_NOTREG;
2527 PerlIO_debug("%d _is_ a regular file\n",fd);
2533 PerlIOUnix_refcnt_inc(fd);
2534 PERL_UNUSED_CONTEXT;
2538 PerlIOUnix_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2540 IV code = PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
2541 if (*PerlIONext(f)) {
2542 /* We never call down so do any pending stuff now */
2543 PerlIO_flush(PerlIONext(f));
2545 * XXX could (or should) we retrieve the oflags from the open file
2546 * handle rather than believing the "mode" we are passed in? XXX
2547 * Should the value on NULL mode be 0 or -1?
2549 PerlIOUnix_setfd(aTHX_ f, PerlIO_fileno(PerlIONext(f)),
2550 mode ? PerlIOUnix_oflags(mode) : -1);
2552 PerlIOBase(f)->flags |= PERLIO_F_OPEN;
2558 PerlIOUnix_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
2560 const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2562 PERL_UNUSED_CONTEXT;
2563 if (PerlIOBase(f)->flags & PERLIO_F_NOTREG) {
2565 SETERRNO(ESPIPE, LIB_INVARG);
2567 SETERRNO(EINVAL, LIB_INVARG);
2571 new_loc = PerlLIO_lseek(fd, offset, whence);
2572 if (new_loc == (Off_t) - 1)
2574 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
2579 PerlIOUnix_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
2580 IV n, const char *mode, int fd, int imode,
2581 int perm, PerlIO *f, int narg, SV **args)
2583 if (PerlIOValid(f)) {
2584 if (PerlIOBase(f)->flags & PERLIO_F_OPEN)
2585 (*PerlIOBase(f)->tab->Close)(aTHX_ f);
2588 if (*mode == IoTYPE_NUMERIC)
2591 imode = PerlIOUnix_oflags(mode);
2595 const char *path = SvPV_nolen_const(*args);
2596 fd = PerlLIO_open3(path, imode, perm);
2600 if (*mode == IoTYPE_IMPLICIT)
2603 f = PerlIO_allocate(aTHX);
2605 if (!PerlIOValid(f)) {
2606 if (!(f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg))) {
2610 PerlIOUnix_setfd(aTHX_ f, fd, imode);
2611 PerlIOBase(f)->flags |= PERLIO_F_OPEN;
2612 if (*mode == IoTYPE_APPEND)
2613 PerlIOUnix_seek(aTHX_ f, 0, SEEK_END);
2620 * FIXME: pop layers ???
2628 PerlIOUnix_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2630 const PerlIOUnix * const os = PerlIOSelf(o, PerlIOUnix);
2632 if (flags & PERLIO_DUP_FD) {
2633 fd = PerlLIO_dup(fd);
2636 f = PerlIOBase_dup(aTHX_ f, o, param, flags);
2638 /* If all went well overwrite fd in dup'ed lay with the dup()'ed fd */
2639 PerlIOUnix_setfd(aTHX_ f, fd, os->oflags);
2648 PerlIOUnix_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
2651 const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2652 #ifdef PERLIO_STD_SPECIAL
2654 return PERLIO_STD_IN(fd, vbuf, count);
2656 if (!(PerlIOBase(f)->flags & PERLIO_F_CANREAD) ||
2657 PerlIOBase(f)->flags & (PERLIO_F_EOF|PERLIO_F_ERROR)) {
2661 const SSize_t len = PerlLIO_read(fd, vbuf, count);
2662 if (len >= 0 || errno != EINTR) {
2664 if (errno != EAGAIN) {
2665 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2668 else if (len == 0 && count != 0) {
2669 PerlIOBase(f)->flags |= PERLIO_F_EOF;
2680 PerlIOUnix_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
2683 const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2684 #ifdef PERLIO_STD_SPECIAL
2685 if (fd == 1 || fd == 2)
2686 return PERLIO_STD_OUT(fd, vbuf, count);
2689 const SSize_t len = PerlLIO_write(fd, vbuf, count);
2690 if (len >= 0 || errno != EINTR) {
2692 if (errno != EAGAIN) {
2693 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2704 PerlIOUnix_tell(pTHX_ PerlIO *f)
2706 PERL_UNUSED_CONTEXT;
2708 return PerlLIO_lseek(PerlIOSelf(f, PerlIOUnix)->fd, 0, SEEK_CUR);
2713 PerlIOUnix_close(pTHX_ PerlIO *f)
2716 const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2718 if (PerlIOBase(f)->flags & PERLIO_F_OPEN) {
2719 if (PerlIOUnix_refcnt_dec(fd) > 0) {
2720 PerlIOBase(f)->flags &= ~PERLIO_F_OPEN;
2725 SETERRNO(EBADF,SS_IVCHAN);
2728 while (PerlLIO_close(fd) != 0) {
2729 if (errno != EINTR) {
2736 PerlIOBase(f)->flags &= ~PERLIO_F_OPEN;
2741 PERLIO_FUNCS_DECL(PerlIO_unix) = {
2742 sizeof(PerlIO_funcs),
2749 PerlIOBase_binmode, /* binmode */
2759 PerlIOBase_noop_ok, /* flush */
2760 PerlIOBase_noop_fail, /* fill */
2763 PerlIOBase_clearerr,
2764 PerlIOBase_setlinebuf,
2765 NULL, /* get_base */
2766 NULL, /* get_bufsiz */
2769 NULL, /* set_ptrcnt */
2772 /*--------------------------------------------------------------------------------------*/
2777 #if defined(VMS) && !defined(STDIO_BUFFER_WRITABLE)
2778 /* perl5.8 - This ensures the last minute VMS ungetc fix is not
2779 broken by the last second glibc 2.3 fix
2781 #define STDIO_BUFFER_WRITABLE
2786 struct _PerlIO base;
2787 FILE *stdio; /* The stream */
2791 PerlIOStdio_fileno(pTHX_ PerlIO *f)
2793 PERL_UNUSED_CONTEXT;
2795 if (PerlIOValid(f)) {
2796 FILE * const s = PerlIOSelf(f, PerlIOStdio)->stdio;
2798 return PerlSIO_fileno(s);
2805 PerlIOStdio_mode(const char *mode, char *tmode)
2807 char * const ret = tmode;
2813 #if defined(PERLIO_USING_CRLF) || defined(__CYGWIN__)
2821 PerlIOStdio_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2824 if (PerlIOValid(f) && PerlIOValid(n = PerlIONext(f))) {
2825 PerlIO_funcs * const toptab = PerlIOBase(n)->tab;
2826 if (toptab == tab) {
2827 /* Top is already stdio - pop self (duplicate) and use original */
2828 PerlIO_pop(aTHX_ f);
2831 const int fd = PerlIO_fileno(n);
2834 if (fd >= 0 && (stdio = PerlSIO_fdopen(fd,
2835 mode = PerlIOStdio_mode(mode, tmode)))) {
2836 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2837 /* We never call down so do any pending stuff now */
2838 PerlIO_flush(PerlIONext(f));
2845 return PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
2850 PerlIO_importFILE(FILE *stdio, const char *mode)
2856 if (!mode || !*mode) {
2857 /* We need to probe to see how we can open the stream
2858 so start with read/write and then try write and read
2859 we dup() so that we can fclose without loosing the fd.
2861 Note that the errno value set by a failing fdopen
2862 varies between stdio implementations.
2864 const int fd = PerlLIO_dup(fileno(stdio));
2865 FILE *f2 = PerlSIO_fdopen(fd, (mode = "r+"));
2867 f2 = PerlSIO_fdopen(fd, (mode = "w"));
2870 f2 = PerlSIO_fdopen(fd, (mode = "r"));
2873 /* Don't seem to be able to open */
2879 if ((f = PerlIO_push(aTHX_(f = PerlIO_allocate(aTHX)), PERLIO_FUNCS_CAST(&PerlIO_stdio), mode, NULL))) {
2880 s = PerlIOSelf(f, PerlIOStdio);
2888 PerlIOStdio_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
2889 IV n, const char *mode, int fd, int imode,
2890 int perm, PerlIO *f, int narg, SV **args)
2893 if (PerlIOValid(f)) {
2894 const char * const path = SvPV_nolen_const(*args);
2895 PerlIOStdio * const s = PerlIOSelf(f, PerlIOStdio);
2897 PerlIOUnix_refcnt_dec(fileno(s->stdio));
2898 stdio = PerlSIO_freopen(path, (mode = PerlIOStdio_mode(mode, tmode)),
2903 PerlIOUnix_refcnt_inc(fileno(s->stdio));
2908 const char * const path = SvPV_nolen_const(*args);
2909 if (*mode == IoTYPE_NUMERIC) {
2911 fd = PerlLIO_open3(path, imode, perm);
2915 bool appended = FALSE;
2917 /* Cygwin wants its 'b' early. */
2919 mode = PerlIOStdio_mode(mode, tmode);
2921 stdio = PerlSIO_fopen(path, mode);
2924 f = PerlIO_allocate(aTHX);
2927 mode = PerlIOStdio_mode(mode, tmode);
2928 f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg);
2930 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2931 PerlIOUnix_refcnt_inc(fileno(stdio));
2933 PerlSIO_fclose(stdio);
2945 if (*mode == IoTYPE_IMPLICIT) {
2952 stdio = PerlSIO_stdin;
2955 stdio = PerlSIO_stdout;
2958 stdio = PerlSIO_stderr;
2963 stdio = PerlSIO_fdopen(fd, mode =
2964 PerlIOStdio_mode(mode, tmode));
2968 f = PerlIO_allocate(aTHX);
2970 if ((f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg))) {
2971 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2972 PerlIOUnix_refcnt_inc(fileno(stdio));
2982 PerlIOStdio_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2984 /* This assumes no layers underneath - which is what
2985 happens, but is not how I remember it. NI-S 2001/10/16
2987 if ((f = PerlIOBase_dup(aTHX_ f, o, param, flags))) {
2988 FILE *stdio = PerlIOSelf(o, PerlIOStdio)->stdio;
2989 const int fd = fileno(stdio);
2991 if (flags & PERLIO_DUP_FD) {
2992 const int dfd = PerlLIO_dup(fileno(stdio));
2994 stdio = PerlSIO_fdopen(dfd, PerlIO_modestr(o,mode));
2999 /* FIXME: To avoid messy error recovery if dup fails
3000 re-use the existing stdio as though flag was not set
3004 stdio = PerlSIO_fdopen(fd, PerlIO_modestr(o,mode));
3006 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
3007 PerlIOUnix_refcnt_inc(fileno(stdio));
3013 PerlIOStdio_invalidate_fileno(pTHX_ FILE *f)
3015 PERL_UNUSED_CONTEXT;
3017 /* XXX this could use PerlIO_canset_fileno() and
3018 * PerlIO_set_fileno() support from Configure
3020 # if defined(__UCLIBC__)
3021 /* uClibc must come before glibc because it defines __GLIBC__ as well. */
3024 # elif defined(__GLIBC__)
3025 /* There may be a better way for GLIBC:
3026 - libio.h defines a flag to not close() on cleanup
3030 # elif defined(__sun__)
3033 # elif defined(__hpux)
3037 /* Next one ->_file seems to be a reasonable fallback, i.e. if
3038 your platform does not have special entry try this one.
3039 [For OSF only have confirmation for Tru64 (alpha)
3040 but assume other OSFs will be similar.]
3042 # elif defined(_AIX) || defined(__osf__) || defined(__irix__)
3045 # elif defined(__FreeBSD__)
3046 /* There may be a better way on FreeBSD:
3047 - we could insert a dummy func in the _close function entry
3048 f->_close = (int (*)(void *)) dummy_close;
3052 # elif defined(__OpenBSD__)
3053 /* There may be a better way on OpenBSD:
3054 - we could insert a dummy func in the _close function entry
3055 f->_close = (int (*)(void *)) dummy_close;
3059 # elif defined(__EMX__)
3060 /* f->_flags &= ~_IOOPEN; */ /* Will leak stream->_buffer */
3063 # elif defined(__CYGWIN__)
3064 /* There may be a better way on CYGWIN:
3065 - we could insert a dummy func in the _close function entry
3066 f->_close = (int (*)(void *)) dummy_close;
3070 # elif defined(WIN32)
3071 # if defined(__BORLANDC__)
3072 f->fd = PerlLIO_dup(fileno(f));
3073 # elif defined(UNDER_CE)
3074 /* WIN_CE does not have access to FILE internals, it hardly has FILE
3083 /* Sarathy's code did this - we fall back to a dup/dup2 hack
3084 (which isn't thread safe) instead
3086 # error "Don't know how to set FILE.fileno on your platform"
3094 PerlIOStdio_close(pTHX_ PerlIO *f)
3096 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3102 const int fd = fileno(stdio);
3107 #ifdef SOCKS5_VERSION_NAME
3108 /* Socks lib overrides close() but stdio isn't linked to
3109 that library (though we are) - so we must call close()
3110 on sockets on stdio's behalf.
3113 Sock_size_t optlen = sizeof(int);
3114 if (getsockopt(fd, SOL_SOCKET, SO_TYPE, (void *) &optval, &optlen) == 0)
3117 if (PerlIOUnix_refcnt_dec(fd) > 0) /* File descriptor still in use */
3120 /* For STD* handles, don't close stdio, since we shared the FILE *, too. */
3121 if (stdio == stdin) /* Some stdios are buggy fflush-ing inputs */
3123 if (stdio == stdout || stdio == stderr)
3124 return PerlIO_flush(f);
3125 /* Tricky - must fclose(stdio) to free memory but not close(fd)
3126 Use Sarathy's trick from maint-5.6 to invalidate the
3127 fileno slot of the FILE *
3129 result = PerlIO_flush(f);
3131 invalidate = PerlIOStdio_invalidate_fileno(aTHX_ stdio);
3133 dupfd = PerlLIO_dup(fd);
3135 result = PerlSIO_fclose(stdio);
3136 /* We treat error from stdio as success if we invalidated
3137 errno may NOT be expected EBADF
3139 if (invalidate && result != 0) {
3143 #ifdef SOCKS5_VERSION_NAME
3144 /* in SOCKS' case, let close() determine return value */
3148 PerlLIO_dup2(dupfd,fd);
3149 PerlLIO_close(dupfd);
3156 PerlIOStdio_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
3159 FILE * const s = PerlIOSelf(f, PerlIOStdio)->stdio;
3163 STDCHAR *buf = (STDCHAR *) vbuf;
3165 * Perl is expecting PerlIO_getc() to fill the buffer Linux's
3166 * stdio does not do that for fread()
3168 const int ch = PerlSIO_fgetc(s);
3175 got = PerlSIO_fread(vbuf, 1, count, s);
3176 if (got == 0 && PerlSIO_ferror(s))
3178 if (got >= 0 || errno != EINTR)
3181 SETERRNO(0,0); /* just in case */
3187 PerlIOStdio_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3190 FILE * const s = PerlIOSelf(f, PerlIOStdio)->stdio;
3192 #ifdef STDIO_BUFFER_WRITABLE
3193 if (PerlIO_fast_gets(f) && PerlIO_has_base(f)) {
3194 STDCHAR *buf = ((STDCHAR *) vbuf) + count;
3195 STDCHAR *base = PerlIO_get_base(f);
3196 SSize_t cnt = PerlIO_get_cnt(f);
3197 STDCHAR *ptr = PerlIO_get_ptr(f);
3198 SSize_t avail = ptr - base;
3200 if (avail > count) {
3204 Move(buf-avail,ptr,avail,STDCHAR);
3207 PerlIO_set_ptrcnt(f,ptr,cnt+avail);
3208 if (PerlSIO_feof(s) && unread >= 0)
3209 PerlSIO_clearerr(s);
3214 if (PerlIO_has_cntptr(f)) {
3215 /* We can get pointer to buffer but not its base
3216 Do ungetc() but check chars are ending up in the
3219 STDCHAR *eptr = (STDCHAR*)PerlSIO_get_ptr(s);
3220 STDCHAR *buf = ((STDCHAR *) vbuf) + count;
3222 const int ch = *--buf & 0xFF;
3223 if (ungetc(ch,s) != ch) {
3224 /* ungetc did not work */
3227 if ((STDCHAR*)PerlSIO_get_ptr(s) != --eptr || ((*eptr & 0xFF) != ch)) {
3228 /* Did not change pointer as expected */
3229 fgetc(s); /* get char back again */
3239 unread += PerlIOBase_unread(aTHX_ f, vbuf, count);
3245 PerlIOStdio_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3250 got = PerlSIO_fwrite(vbuf, 1, count,
3251 PerlIOSelf(f, PerlIOStdio)->stdio);
3252 if (got >= 0 || errno != EINTR)
3255 SETERRNO(0,0); /* just in case */
3261 PerlIOStdio_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3263 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3264 PERL_UNUSED_CONTEXT;
3266 return PerlSIO_fseek(stdio, offset, whence);
3270 PerlIOStdio_tell(pTHX_ PerlIO *f)
3272 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3273 PERL_UNUSED_CONTEXT;
3275 return PerlSIO_ftell(stdio);
3279 PerlIOStdio_flush(pTHX_ PerlIO *f)
3281 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3282 PERL_UNUSED_CONTEXT;
3284 if (PerlIOBase(f)->flags & PERLIO_F_CANWRITE) {
3285 return PerlSIO_fflush(stdio);
3291 * FIXME: This discards ungetc() and pre-read stuff which is not
3292 * right if this is just a "sync" from a layer above Suspect right
3293 * design is to do _this_ but not have layer above flush this
3294 * layer read-to-read
3297 * Not writeable - sync by attempting a seek
3299 const int err = errno;
3300 if (PerlSIO_fseek(stdio, (Off_t) 0, SEEK_CUR) != 0)
3308 PerlIOStdio_eof(pTHX_ PerlIO *f)
3310 PERL_UNUSED_CONTEXT;
3312 return PerlSIO_feof(PerlIOSelf(f, PerlIOStdio)->stdio);
3316 PerlIOStdio_error(pTHX_ PerlIO *f)
3318 PERL_UNUSED_CONTEXT;
3320 return PerlSIO_ferror(PerlIOSelf(f, PerlIOStdio)->stdio);
3324 PerlIOStdio_clearerr(pTHX_ PerlIO *f)
3326 PERL_UNUSED_CONTEXT;
3328 PerlSIO_clearerr(PerlIOSelf(f, PerlIOStdio)->stdio);
3332 PerlIOStdio_setlinebuf(pTHX_ PerlIO *f)
3334 PERL_UNUSED_CONTEXT;
3336 #ifdef HAS_SETLINEBUF
3337 PerlSIO_setlinebuf(PerlIOSelf(f, PerlIOStdio)->stdio);
3339 PerlSIO_setvbuf(PerlIOSelf(f, PerlIOStdio)->stdio, NULL, _IOLBF, 0);
3345 PerlIOStdio_get_base(pTHX_ PerlIO *f)
3347 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3348 return (STDCHAR*)PerlSIO_get_base(stdio);
3352 PerlIOStdio_get_bufsiz(pTHX_ PerlIO *f)
3354 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3355 return PerlSIO_get_bufsiz(stdio);
3359 #ifdef USE_STDIO_PTR
3361 PerlIOStdio_get_ptr(pTHX_ PerlIO *f)
3363 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3364 return (STDCHAR*)PerlSIO_get_ptr(stdio);
3368 PerlIOStdio_get_cnt(pTHX_ PerlIO *f)
3370 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3371 return PerlSIO_get_cnt(stdio);
3375 PerlIOStdio_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
3377 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3379 #ifdef STDIO_PTR_LVALUE
3380 PerlSIO_set_ptr(stdio, ptr); /* LHS STDCHAR* cast non-portable */
3381 #ifdef STDIO_PTR_LVAL_SETS_CNT
3382 if (PerlSIO_get_cnt(stdio) != (cnt)) {
3383 assert(PerlSIO_get_cnt(stdio) == (cnt));
3386 #if (!defined(STDIO_PTR_LVAL_NOCHANGE_CNT))
3388 * Setting ptr _does_ change cnt - we are done
3392 #else /* STDIO_PTR_LVALUE */
3394 #endif /* STDIO_PTR_LVALUE */
3397 * Now (or only) set cnt
3399 #ifdef STDIO_CNT_LVALUE
3400 PerlSIO_set_cnt(stdio, cnt);
3401 #else /* STDIO_CNT_LVALUE */
3402 #if (defined(STDIO_PTR_LVALUE) && defined(STDIO_PTR_LVAL_SETS_CNT))
3403 PerlSIO_set_ptr(stdio,
3404 PerlSIO_get_ptr(stdio) + (PerlSIO_get_cnt(stdio) -
3406 #else /* STDIO_PTR_LVAL_SETS_CNT */
3408 #endif /* STDIO_PTR_LVAL_SETS_CNT */
3409 #endif /* STDIO_CNT_LVALUE */
3416 PerlIOStdio_fill(pTHX_ PerlIO *f)
3418 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3420 PERL_UNUSED_CONTEXT;
3423 * fflush()ing read-only streams can cause trouble on some stdio-s
3425 if ((PerlIOBase(f)->flags & PERLIO_F_CANWRITE)) {
3426 if (PerlSIO_fflush(stdio) != 0)
3430 c = PerlSIO_fgetc(stdio);
3433 if (! PerlSIO_ferror(stdio) || errno != EINTR)
3439 #if (defined(STDIO_PTR_LVALUE) && (defined(STDIO_CNT_LVALUE) || defined(STDIO_PTR_LVAL_SETS_CNT)))
3441 #ifdef STDIO_BUFFER_WRITABLE
3442 if (PerlIO_fast_gets(f) && PerlIO_has_base(f)) {
3443 /* Fake ungetc() to the real buffer in case system's ungetc
3446 STDCHAR *base = (STDCHAR*)PerlSIO_get_base(stdio);
3447 SSize_t cnt = PerlSIO_get_cnt(stdio);
3448 STDCHAR *ptr = (STDCHAR*)PerlSIO_get_ptr(stdio);
3449 if (ptr == base+1) {
3450 *--ptr = (STDCHAR) c;
3451 PerlIOStdio_set_ptrcnt(aTHX_ f,ptr,cnt+1);
3452 if (PerlSIO_feof(stdio))
3453 PerlSIO_clearerr(stdio);
3459 if (PerlIO_has_cntptr(f)) {
3461 if (PerlIOStdio_unread(aTHX_ f,&ch,1) == 1) {
3468 /* An ungetc()d char is handled separately from the regular
3469 * buffer, so we stuff it in the buffer ourselves.
3470 * Should never get called as should hit code above
3472 *(--((*stdio)->_ptr)) = (unsigned char) c;
3475 /* If buffer snoop scheme above fails fall back to
3478 if (PerlSIO_ungetc(c, stdio) != c)
3486 PERLIO_FUNCS_DECL(PerlIO_stdio) = {
3487 sizeof(PerlIO_funcs),
3489 sizeof(PerlIOStdio),
3490 PERLIO_K_BUFFERED|PERLIO_K_RAW,
3494 PerlIOBase_binmode, /* binmode */
3508 PerlIOStdio_clearerr,
3509 PerlIOStdio_setlinebuf,
3511 PerlIOStdio_get_base,
3512 PerlIOStdio_get_bufsiz,
3517 #ifdef USE_STDIO_PTR
3518 PerlIOStdio_get_ptr,
3519 PerlIOStdio_get_cnt,
3520 # if defined(HAS_FAST_STDIO) && defined(USE_FAST_STDIO)
3521 PerlIOStdio_set_ptrcnt,
3524 # endif /* HAS_FAST_STDIO && USE_FAST_STDIO */
3529 #endif /* USE_STDIO_PTR */
3532 /* Note that calls to PerlIO_exportFILE() are reversed using
3533 * PerlIO_releaseFILE(), not importFILE. */
3535 PerlIO_exportFILE(PerlIO * f, const char *mode)
3539 if (PerlIOValid(f)) {
3542 if (!mode || !*mode) {
3543 mode = PerlIO_modestr(f, buf);
3545 stdio = PerlSIO_fdopen(PerlIO_fileno(f), mode);
3549 /* De-link any lower layers so new :stdio sticks */
3551 if ((f2 = PerlIO_push(aTHX_ f, PERLIO_FUNCS_CAST(&PerlIO_stdio), buf, NULL))) {
3552 PerlIOStdio *s = PerlIOSelf((f = f2), PerlIOStdio);
3554 /* Link previous lower layers under new one */
3558 /* restore layers list */
3568 PerlIO_findFILE(PerlIO *f)
3572 if (l->tab == &PerlIO_stdio) {
3573 PerlIOStdio *s = PerlIOSelf(&l, PerlIOStdio);
3576 l = *PerlIONext(&l);
3578 /* Uses fallback "mode" via PerlIO_modestr() in PerlIO_exportFILE */
3579 return PerlIO_exportFILE(f, NULL);
3582 /* Use this to reverse PerlIO_exportFILE calls. */
3584 PerlIO_releaseFILE(PerlIO *p, FILE *f)
3589 if (l->tab == &PerlIO_stdio) {
3590 PerlIOStdio *s = PerlIOSelf(&l, PerlIOStdio);
3591 if (s->stdio == f) {
3593 PerlIO_pop(aTHX_ p);
3602 /*--------------------------------------------------------------------------------------*/
3604 * perlio buffer layer
3608 PerlIOBuf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
3610 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3611 const int fd = PerlIO_fileno(f);
3612 if (fd >= 0 && PerlLIO_isatty(fd)) {
3613 PerlIOBase(f)->flags |= PERLIO_F_LINEBUF | PERLIO_F_TTY;
3615 if (*PerlIONext(f)) {
3616 const Off_t posn = PerlIO_tell(PerlIONext(f));
3617 if (posn != (Off_t) - 1) {
3621 return PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
3625 PerlIOBuf_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
3626 IV n, const char *mode, int fd, int imode, int perm,
3627 PerlIO *f, int narg, SV **args)
3629 if (PerlIOValid(f)) {
3630 PerlIO *next = PerlIONext(f);
3632 PerlIO_layer_fetch(aTHX_ layers, n - 1, PerlIOBase(next)->tab);
3633 if (tab && tab->Open)
3635 (*tab->Open)(aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
3637 if (!next || (*PerlIOBase(f)->tab->Pushed) (aTHX_ f, mode, PerlIOArg, self) != 0) {
3642 PerlIO_funcs *tab = PerlIO_layer_fetch(aTHX_ layers, n - 1, PerlIO_default_btm());
3644 if (*mode == IoTYPE_IMPLICIT) {
3650 if (tab && tab->Open)
3651 f = (*tab->Open)(aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
3654 SETERRNO(EINVAL, LIB_INVARG);
3656 if (PerlIO_push(aTHX_ f, self, mode, PerlIOArg) == 0) {
3658 * if push fails during open, open fails. close will pop us.
3663 fd = PerlIO_fileno(f);
3664 if (init && fd == 2) {
3666 * Initial stderr is unbuffered
3668 PerlIOBase(f)->flags |= PERLIO_F_UNBUF;
3670 #ifdef PERLIO_USING_CRLF
3671 # ifdef PERLIO_IS_BINMODE_FD
3672 if (PERLIO_IS_BINMODE_FD(fd))
3673 PerlIO_binmode(aTHX_ f, '<'/*not used*/, O_BINARY, NULL);
3677 * do something about failing setmode()? --jhi
3679 PerlLIO_setmode(fd, O_BINARY);
3688 * This "flush" is akin to sfio's sync in that it handles files in either
3689 * read or write state. For write state, we put the postponed data through
3690 * the next layers. For read state, we seek() the next layers to the
3691 * offset given by current position in the buffer, and discard the buffer
3692 * state (XXXX supposed to be for seek()able buffers only, but now it is done
3693 * in any case?). Then the pass the stick further in chain.
3696 PerlIOBuf_flush(pTHX_ PerlIO *f)
3698 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3700 PerlIO *n = PerlIONext(f);
3701 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF) {
3703 * write() the buffer
3705 const STDCHAR *buf = b->buf;
3706 const STDCHAR *p = buf;
3707 while (p < b->ptr) {
3708 SSize_t count = PerlIO_write(n, p, b->ptr - p);
3712 else if (count < 0 || PerlIO_error(n)) {
3713 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
3718 b->posn += (p - buf);
3720 else if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3721 STDCHAR *buf = PerlIO_get_base(f);
3723 * Note position change
3725 b->posn += (b->ptr - buf);
3726 if (b->ptr < b->end) {
3727 /* We did not consume all of it - try and seek downstream to
3728 our logical position
3730 if (PerlIOValid(n) && PerlIO_seek(n, b->posn, SEEK_SET) == 0) {
3731 /* Reload n as some layers may pop themselves on seek */
3732 b->posn = PerlIO_tell(n = PerlIONext(f));
3735 /* Seek failed (e.g. pipe or tty). Do NOT clear buffer or pre-read
3736 data is lost for good - so return saying "ok" having undone
3739 b->posn -= (b->ptr - buf);
3744 b->ptr = b->end = b->buf;
3745 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3746 /* We check for Valid because of dubious decision to make PerlIO_flush(NULL) flush all */
3747 if (PerlIOValid(n) && PerlIO_flush(n) != 0)
3752 /* This discards the content of the buffer after b->ptr, and rereads
3753 * the buffer from the position off in the layer downstream; here off
3754 * is at offset corresponding to b->ptr - b->buf.
3757 PerlIOBuf_fill(pTHX_ PerlIO *f)
3759 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3760 PerlIO *n = PerlIONext(f);
3763 * Down-stream flush is defined not to loose read data so is harmless.
3764 * we would not normally be fill'ing if there was data left in anycase.
3766 if (PerlIO_flush(f) != 0) /* XXXX Check that its seek() succeeded?! */
3768 if (PerlIOBase(f)->flags & PERLIO_F_TTY)
3769 PerlIOBase_flush_linebuf(aTHX);
3772 PerlIO_get_base(f); /* allocate via vtable */
3774 assert(b->buf); /* The b->buf does get allocated via the vtable system. */
3776 b->ptr = b->end = b->buf;
3778 if (!PerlIOValid(n)) {
3779 PerlIOBase(f)->flags |= PERLIO_F_EOF;
3783 if (PerlIO_fast_gets(n)) {
3785 * Layer below is also buffered. We do _NOT_ want to call its
3786 * ->Read() because that will loop till it gets what we asked for
3787 * which may hang on a pipe etc. Instead take anything it has to
3788 * hand, or ask it to fill _once_.
3790 avail = PerlIO_get_cnt(n);
3792 avail = PerlIO_fill(n);
3794 avail = PerlIO_get_cnt(n);
3796 if (!PerlIO_error(n) && PerlIO_eof(n))
3801 STDCHAR *ptr = PerlIO_get_ptr(n);
3802 const SSize_t cnt = avail;
3803 if (avail > (SSize_t)b->bufsiz)
3805 Copy(ptr, b->buf, avail, STDCHAR);
3806 PerlIO_set_ptrcnt(n, ptr + avail, cnt - avail);
3810 avail = PerlIO_read(n, b->ptr, b->bufsiz);
3814 PerlIOBase(f)->flags |= PERLIO_F_EOF;
3816 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
3819 b->end = b->buf + avail;
3820 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3825 PerlIOBuf_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
3827 if (PerlIOValid(f)) {
3828 const PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3831 return PerlIOBase_read(aTHX_ f, vbuf, count);
3837 PerlIOBuf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3839 const STDCHAR *buf = (const STDCHAR *) vbuf + count;
3840 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3843 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
3848 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3850 * Buffer is already a read buffer, we can overwrite any chars
3851 * which have been read back to buffer start
3853 avail = (b->ptr - b->buf);
3857 * Buffer is idle, set it up so whole buffer is available for
3861 b->end = b->buf + avail;
3863 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3865 * Buffer extends _back_ from where we are now
3867 b->posn -= b->bufsiz;
3869 if (avail > (SSize_t) count) {
3871 * If we have space for more than count, just move count
3879 * In simple stdio-like ungetc() case chars will be already
3882 if (buf != b->ptr) {
3883 Copy(buf, b->ptr, avail, STDCHAR);
3887 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
3891 unread += PerlIOBase_unread(aTHX_ f, vbuf, count);
3897 PerlIOBuf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3899 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3900 const STDCHAR *buf = (const STDCHAR *) vbuf;
3901 const STDCHAR *flushptr = buf;
3905 if (!(PerlIOBase(f)->flags & PERLIO_F_CANWRITE))
3907 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3908 if (PerlIO_flush(f) != 0) {
3912 if (PerlIOBase(f)->flags & PERLIO_F_LINEBUF) {
3913 flushptr = buf + count;
3914 while (flushptr > buf && *(flushptr - 1) != '\n')
3918 SSize_t avail = b->bufsiz - (b->ptr - b->buf);
3919 if ((SSize_t) count < avail)
3921 if (flushptr > buf && flushptr <= buf + avail)
3922 avail = flushptr - buf;
3923 PerlIOBase(f)->flags |= PERLIO_F_WRBUF;
3925 Copy(buf, b->ptr, avail, STDCHAR);
3930 if (buf == flushptr)
3933 if (b->ptr >= (b->buf + b->bufsiz))
3936 if (PerlIOBase(f)->flags & PERLIO_F_UNBUF)
3942 PerlIOBuf_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3945 if ((code = PerlIO_flush(f)) == 0) {
3946 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
3947 code = PerlIO_seek(PerlIONext(f), offset, whence);
3949 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3950 b->posn = PerlIO_tell(PerlIONext(f));
3957 PerlIOBuf_tell(pTHX_ PerlIO *f)
3959 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3961 * b->posn is file position where b->buf was read, or will be written
3963 Off_t posn = b->posn;
3964 if ((PerlIOBase(f)->flags & PERLIO_F_APPEND) &&
3965 (PerlIOBase(f)->flags & PERLIO_F_WRBUF)) {
3967 /* As O_APPEND files are normally shared in some sense it is better
3972 /* when file is NOT shared then this is sufficient */
3973 PerlIO_seek(PerlIONext(f),0, SEEK_END);
3975 posn = b->posn = PerlIO_tell(PerlIONext(f));
3979 * If buffer is valid adjust position by amount in buffer
3981 posn += (b->ptr - b->buf);
3987 PerlIOBuf_popped(pTHX_ PerlIO *f)
3989 const IV code = PerlIOBase_popped(aTHX_ f);
3990 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3991 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
3994 b->ptr = b->end = b->buf = NULL;
3995 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
4000 PerlIOBuf_close(pTHX_ PerlIO *f)
4002 const IV code = PerlIOBase_close(aTHX_ f);
4003 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4004 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
4007 b->ptr = b->end = b->buf = NULL;
4008 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
4013 PerlIOBuf_get_ptr(pTHX_ PerlIO *f)
4015 const PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4022 PerlIOBuf_get_cnt(pTHX_ PerlIO *f)
4024 const PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4027 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF)
4028 return (b->end - b->ptr);
4033 PerlIOBuf_get_base(pTHX_ PerlIO *f)
4035 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4036 PERL_UNUSED_CONTEXT;
4041 b->buf = Newxz(b->buf,b->bufsiz, STDCHAR);
4043 b->buf = (STDCHAR *) & b->oneword;
4044 b->bufsiz = sizeof(b->oneword);
4046 b->end = b->ptr = b->buf;
4052 PerlIOBuf_bufsiz(pTHX_ PerlIO *f)
4054 const PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4057 return (b->end - b->buf);
4061 PerlIOBuf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
4063 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4067 if (PerlIO_get_cnt(f) != cnt || b->ptr < b->buf) {
4068 assert(PerlIO_get_cnt(f) == cnt);
4069 assert(b->ptr >= b->buf);
4071 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4075 PerlIOBuf_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
4077 return PerlIOBase_dup(aTHX_ f, o, param, flags);
4082 PERLIO_FUNCS_DECL(PerlIO_perlio) = {
4083 sizeof(PerlIO_funcs),
4086 PERLIO_K_BUFFERED|PERLIO_K_RAW,
4090 PerlIOBase_binmode, /* binmode */
4104 PerlIOBase_clearerr,
4105 PerlIOBase_setlinebuf,
4110 PerlIOBuf_set_ptrcnt,
4113 /*--------------------------------------------------------------------------------------*/
4115 * Temp layer to hold unread chars when cannot do it any other way
4119 PerlIOPending_fill(pTHX_ PerlIO *f)
4122 * Should never happen
4129 PerlIOPending_close(pTHX_ PerlIO *f)
4132 * A tad tricky - flush pops us, then we close new top
4135 return PerlIO_close(f);
4139 PerlIOPending_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
4142 * A tad tricky - flush pops us, then we seek new top
4145 return PerlIO_seek(f, offset, whence);
4150 PerlIOPending_flush(pTHX_ PerlIO *f)
4152 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4153 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
4157 PerlIO_pop(aTHX_ f);
4162 PerlIOPending_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
4168 PerlIOBuf_set_ptrcnt(aTHX_ f, ptr, cnt);
4173 PerlIOPending_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
4175 const IV code = PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
4176 PerlIOl * const l = PerlIOBase(f);
4178 * Our PerlIO_fast_gets must match what we are pushed on, or sv_gets()
4179 * etc. get muddled when it changes mid-string when we auto-pop.
4181 l->flags = (l->flags & ~(PERLIO_F_FASTGETS | PERLIO_F_UTF8)) |
4182 (PerlIOBase(PerlIONext(f))->
4183 flags & (PERLIO_F_FASTGETS | PERLIO_F_UTF8));
4188 PerlIOPending_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
4190 SSize_t avail = PerlIO_get_cnt(f);
4192 if ((SSize_t)count < avail)
4195 got = PerlIOBuf_read(aTHX_ f, vbuf, avail);
4196 if (got >= 0 && got < (SSize_t)count) {
4197 const SSize_t more =
4198 PerlIO_read(f, ((STDCHAR *) vbuf) + got, count - got);
4199 if (more >= 0 || got == 0)
4205 PERLIO_FUNCS_DECL(PerlIO_pending) = {
4206 sizeof(PerlIO_funcs),
4209 PERLIO_K_BUFFERED|PERLIO_K_RAW, /* not sure about RAW here */
4210 PerlIOPending_pushed,
4213 PerlIOBase_binmode, /* binmode */
4222 PerlIOPending_close,
4223 PerlIOPending_flush,
4227 PerlIOBase_clearerr,
4228 PerlIOBase_setlinebuf,
4233 PerlIOPending_set_ptrcnt,
4238 /*--------------------------------------------------------------------------------------*/
4240 * crlf - translation On read translate CR,LF to "\n" we do this by
4241 * overriding ptr/cnt entries to hand back a line at a time and keeping a
4242 * record of which nl we "lied" about. On write translate "\n" to CR,LF
4244 * c->nl points on the first byte of CR LF pair when it is temporarily
4245 * replaced by LF, or to the last CR of the buffer. In the former case
4246 * the caller thinks that the buffer ends at c->nl + 1, in the latter
4247 * that it ends at c->nl; these two cases can be distinguished by
4248 * *c->nl. c->nl is set during _getcnt() call, and unset during
4249 * _unread() and _flush() calls.
4250 * It only matters for read operations.
4254 PerlIOBuf base; /* PerlIOBuf stuff */
4255 STDCHAR *nl; /* Position of crlf we "lied" about in the
4259 /* Inherit the PERLIO_F_UTF8 flag from previous layer.
4260 * Otherwise the :crlf layer would always revert back to
4264 S_inherit_utf8_flag(PerlIO *f)
4266 PerlIO *g = PerlIONext(f);
4267 if (PerlIOValid(g)) {
4268 if (PerlIOBase(g)->flags & PERLIO_F_UTF8) {
4269 PerlIOBase(f)->flags |= PERLIO_F_UTF8;
4275 PerlIOCrlf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
4278 PerlIOBase(f)->flags |= PERLIO_F_CRLF;
4279 code = PerlIOBuf_pushed(aTHX_ f, mode, arg, tab);
4281 PerlIO_debug("PerlIOCrlf_pushed f=%p %s %s fl=%08" UVxf "\n",
4282 (void*)f, PerlIOBase(f)->tab->name, (mode) ? mode : "(Null)",
4283 PerlIOBase(f)->flags);
4286 /* Enable the first CRLF capable layer you can find, but if none
4287 * found, the one we just pushed is fine. This results in at
4288 * any given moment at most one CRLF-capable layer being enabled
4289 * in the whole layer stack. */
4290 PerlIO *g = PerlIONext(f);
4291 while (PerlIOValid(g)) {
4292 PerlIOl *b = PerlIOBase(g);
4293 if (b && b->tab == &PerlIO_crlf) {
4294 if (!(b->flags & PERLIO_F_CRLF))
4295 b->flags |= PERLIO_F_CRLF;
4296 S_inherit_utf8_flag(g);
4297 PerlIO_pop(aTHX_ f);
4303 S_inherit_utf8_flag(f);
4309 PerlIOCrlf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4311 PerlIOCrlf * const c = PerlIOSelf(f, PerlIOCrlf);
4312 if (c->nl) { /* XXXX Shouldn't it be done only if b->ptr > c->nl? */
4316 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF))
4317 return PerlIOBuf_unread(aTHX_ f, vbuf, count);
4319 const STDCHAR *buf = (const STDCHAR *) vbuf + count;
4320 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4322 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
4327 if (!(PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4328 b->end = b->ptr = b->buf + b->bufsiz;
4329 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4330 b->posn -= b->bufsiz;
4332 while (count > 0 && b->ptr > b->buf) {
4333 const int ch = *--buf;
4335 if (b->ptr - 2 >= b->buf) {
4342 /* If b->ptr - 1 == b->buf, we are undoing reading 0xa */
4343 *--(b->ptr) = 0xa; /* Works even if 0xa == '\r' */
4359 /* XXXX This code assumes that buffer size >=2, but does not check it... */
4361 PerlIOCrlf_get_cnt(pTHX_ PerlIO *f)
4363 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4366 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
4367 PerlIOCrlf * const c = PerlIOSelf(f, PerlIOCrlf);
4368 if ((PerlIOBase(f)->flags & PERLIO_F_CRLF) && (!c->nl || *c->nl == 0xd)) {
4369 STDCHAR *nl = (c->nl) ? c->nl : b->ptr;
4371 while (nl < b->end && *nl != 0xd)
4373 if (nl < b->end && *nl == 0xd) {
4375 if (nl + 1 < b->end) {
4382 * Not CR,LF but just CR
4390 * Blast - found CR as last char in buffer
4395 * They may not care, defer work as long as
4399 return (nl - b->ptr);
4403 b->ptr++; /* say we have read it as far as
4404 * flush() is concerned */
4405 b->buf++; /* Leave space in front of buffer */
4406 /* Note as we have moved buf up flush's
4408 will naturally make posn point at CR
4410 b->bufsiz--; /* Buffer is thus smaller */
4411 code = PerlIO_fill(f); /* Fetch some more */
4412 b->bufsiz++; /* Restore size for next time */
4413 b->buf--; /* Point at space */
4414 b->ptr = nl = b->buf; /* Which is what we hand
4416 *nl = 0xd; /* Fill in the CR */
4418 goto test; /* fill() call worked */
4420 * CR at EOF - just fall through
4422 /* Should we clear EOF though ??? */
4427 return (((c->nl) ? (c->nl + 1) : b->end) - b->ptr);
4433 PerlIOCrlf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
4435 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4436 PerlIOCrlf * const c = PerlIOSelf(f, PerlIOCrlf);
4442 if (ptr == b->end && *c->nl == 0xd) {
4443 /* Defered CR at end of buffer case - we lied about count */
4456 * Test code - delete when it works ...
4458 IV flags = PerlIOBase(f)->flags;
4459 STDCHAR *chk = (c->nl) ? (c->nl+1) : b->end;
4460 if (ptr+cnt == c->nl && c->nl+1 == b->end && *c->nl == 0xd) {
4461 /* Defered CR at end of buffer case - we lied about count */
4467 Perl_croak(aTHX_ "ptr wrong %p != %p fl=%08" UVxf
4468 " nl=%p e=%p for %d", (void*)ptr, (void*)chk,
4469 flags, c->nl, b->end, cnt);
4476 * They have taken what we lied about
4484 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4488 PerlIOCrlf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4490 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF))
4491 return PerlIOBuf_write(aTHX_ f, vbuf, count);
4493 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4494 const STDCHAR *buf = (const STDCHAR *) vbuf;
4495 const STDCHAR * const ebuf = buf + count;
4498 if (!(PerlIOBase(f)->flags & PERLIO_F_CANWRITE))
4500 while (buf < ebuf) {
4501 const STDCHAR * const eptr = b->buf + b->bufsiz;
4502 PerlIOBase(f)->flags |= PERLIO_F_WRBUF;
4503 while (buf < ebuf && b->ptr < eptr) {
4505 if ((b->ptr + 2) > eptr) {
4513 *(b->ptr)++ = 0xd; /* CR */
4514 *(b->ptr)++ = 0xa; /* LF */
4516 if (PerlIOBase(f)->flags & PERLIO_F_LINEBUF) {
4523 *(b->ptr)++ = *buf++;
4525 if (b->ptr >= eptr) {
4531 if (PerlIOBase(f)->flags & PERLIO_F_UNBUF)
4533 return (buf - (STDCHAR *) vbuf);
4538 PerlIOCrlf_flush(pTHX_ PerlIO *f)
4540 PerlIOCrlf * const c = PerlIOSelf(f, PerlIOCrlf);
4545 return PerlIOBuf_flush(aTHX_ f);
4549 PerlIOCrlf_binmode(pTHX_ PerlIO *f)
4551 if ((PerlIOBase(f)->flags & PERLIO_F_CRLF)) {
4552 /* In text mode - flush any pending stuff and flip it */
4553 PerlIOBase(f)->flags &= ~PERLIO_F_CRLF;
4554 #ifndef PERLIO_USING_CRLF
4555 /* CRLF is unusual case - if this is just the :crlf layer pop it */
4556 if (PerlIOBase(f)->tab == &PerlIO_crlf) {
4557 PerlIO_pop(aTHX_ f);
4564 PERLIO_FUNCS_DECL(PerlIO_crlf) = {
4565 sizeof(PerlIO_funcs),
4568 PERLIO_K_BUFFERED | PERLIO_K_CANCRLF | PERLIO_K_RAW,
4570 PerlIOBuf_popped, /* popped */
4572 PerlIOCrlf_binmode, /* binmode */
4576 PerlIOBuf_read, /* generic read works with ptr/cnt lies */
4577 PerlIOCrlf_unread, /* Put CR,LF in buffer for each '\n' */
4578 PerlIOCrlf_write, /* Put CR,LF in buffer for each '\n' */
4586 PerlIOBase_clearerr,
4587 PerlIOBase_setlinebuf,
4592 PerlIOCrlf_set_ptrcnt,
4596 /*--------------------------------------------------------------------------------------*/
4598 * mmap as "buffer" layer
4602 PerlIOBuf base; /* PerlIOBuf stuff */
4603 Mmap_t mptr; /* Mapped address */
4604 Size_t len; /* mapped length */
4605 STDCHAR *bbuf; /* malloced buffer if map fails */
4609 PerlIOMmap_map(pTHX_ PerlIO *f)
4612 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4613 const IV flags = PerlIOBase(f)->flags;
4617 if (flags & PERLIO_F_CANREAD) {
4618 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4619 const int fd = PerlIO_fileno(f);
4621 code = Fstat(fd, &st);
4622 if (code == 0 && S_ISREG(st.st_mode)) {
4623 SSize_t len = st.st_size - b->posn;
4626 if (PL_mmap_page_size <= 0)
4627 Perl_croak(aTHX_ "panic: bad pagesize %" IVdf,
4631 * This is a hack - should never happen - open should
4634 b->posn = PerlIO_tell(PerlIONext(f));
4636 posn = (b->posn / PL_mmap_page_size) * PL_mmap_page_size;
4637 len = st.st_size - posn;
4638 m->mptr = (Mmap_t)mmap(NULL, len, PROT_READ, MAP_SHARED, fd, posn);
4639 if (m->mptr && m->mptr != (Mmap_t) - 1) {
4640 #if 0 && defined(HAS_MADVISE) && defined(MADV_SEQUENTIAL)
4641 madvise(m->mptr, len, MADV_SEQUENTIAL);
4643 #if 0 && defined(HAS_MADVISE) && defined(MADV_WILLNEED)
4644 madvise(m->mptr, len, MADV_WILLNEED);
4646 PerlIOBase(f)->flags =
4647 (flags & ~PERLIO_F_EOF) | PERLIO_F_RDBUF;
4648 b->end = ((STDCHAR *) m->mptr) + len;
4649 b->buf = ((STDCHAR *) m->mptr) + (b->posn - posn);
4658 PerlIOBase(f)->flags =
4659 flags | PERLIO_F_EOF | PERLIO_F_RDBUF;
4661 b->ptr = b->end = b->ptr;
4670 PerlIOMmap_unmap(pTHX_ PerlIO *f)
4672 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4675 PerlIOBuf * const b = &m->base;
4677 /* The munmap address argument is tricky: depending on the
4678 * standard it is either "void *" or "caddr_t" (which is
4679 * usually "char *" (signed or unsigned). If we cast it
4680 * to "void *", those that have it caddr_t and an uptight
4681 * C++ compiler, will freak out. But casting it as char*
4682 * should work. Maybe. (Using Mmap_t figured out by
4683 * Configure doesn't always work, apparently.) */
4684 code = munmap((char*)m->mptr, m->len);
4688 if (PerlIO_seek(PerlIONext(f), b->posn, SEEK_SET) != 0)
4691 b->ptr = b->end = b->buf;
4692 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
4698 PerlIOMmap_get_base(pTHX_ PerlIO *f)
4700 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4701 PerlIOBuf * const b = &m->base;
4702 if (b->buf && (PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4704 * Already have a readbuffer in progress
4710 * We have a write buffer or flushed PerlIOBuf read buffer
4712 m->bbuf = b->buf; /* save it in case we need it again */
4713 b->buf = NULL; /* Clear to trigger below */
4716 PerlIOMmap_map(aTHX_ f); /* Try and map it */
4719 * Map did not work - recover PerlIOBuf buffer if we have one
4724 b->ptr = b->end = b->buf;
4727 return PerlIOBuf_get_base(aTHX_ f);
4731 PerlIOMmap_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4733 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4734 PerlIOBuf * const b = &m->base;
4735 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
4737 if (b->ptr && (b->ptr - count) >= b->buf
4738 && memEQ(b->ptr - count, vbuf, count)) {
4740 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
4745 * Loose the unwritable mapped buffer
4749 * If flush took the "buffer" see if we have one from before
4751 if (!b->buf && m->bbuf)
4754 PerlIOBuf_get_base(aTHX_ f);
4758 return PerlIOBuf_unread(aTHX_ f, vbuf, count);
4762 PerlIOMmap_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4764 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4765 PerlIOBuf * const b = &m->base;
4767 if (!b->buf || !(PerlIOBase(f)->flags & PERLIO_F_WRBUF)) {
4769 * No, or wrong sort of, buffer
4772 if (PerlIOMmap_unmap(aTHX_ f) != 0)
4776 * If unmap took the "buffer" see if we have one from before
4778 if (!b->buf && m->bbuf)
4781 PerlIOBuf_get_base(aTHX_ f);
4785 return PerlIOBuf_write(aTHX_ f, vbuf, count);
4789 PerlIOMmap_flush(pTHX_ PerlIO *f)
4791 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4792 PerlIOBuf * const b = &m->base;
4793 IV code = PerlIOBuf_flush(aTHX_ f);
4795 * Now we are "synced" at PerlIOBuf level
4802 if (PerlIOMmap_unmap(aTHX_ f) != 0)
4807 * We seem to have a PerlIOBuf buffer which was not mapped
4808 * remember it in case we need one later
4817 PerlIOMmap_fill(pTHX_ PerlIO *f)
4819 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4820 IV code = PerlIO_flush(f);
4821 if (code == 0 && !b->buf) {
4822 code = PerlIOMmap_map(aTHX_ f);
4824 if (code == 0 && !(PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4825 code = PerlIOBuf_fill(aTHX_ f);
4831 PerlIOMmap_close(pTHX_ PerlIO *f)
4833 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4834 PerlIOBuf * const b = &m->base;
4835 IV code = PerlIO_flush(f);
4839 b->ptr = b->end = b->buf;
4841 if (PerlIOBuf_close(aTHX_ f) != 0)
4847 PerlIOMmap_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
4849 return PerlIOBase_dup(aTHX_ f, o, param, flags);
4853 PERLIO_FUNCS_DECL(PerlIO_mmap) = {
4854 sizeof(PerlIO_funcs),
4857 PERLIO_K_BUFFERED|PERLIO_K_RAW,
4861 PerlIOBase_binmode, /* binmode */
4875 PerlIOBase_clearerr,
4876 PerlIOBase_setlinebuf,
4877 PerlIOMmap_get_base,
4881 PerlIOBuf_set_ptrcnt,
4884 #endif /* HAS_MMAP */
4887 Perl_PerlIO_stdin(pTHX)
4891 PerlIO_stdstreams(aTHX);
4893 return &PL_perlio[1];
4897 Perl_PerlIO_stdout(pTHX)
4901 PerlIO_stdstreams(aTHX);
4903 return &PL_perlio[2];
4907 Perl_PerlIO_stderr(pTHX)
4911 PerlIO_stdstreams(aTHX);
4913 return &PL_perlio[3];
4916 /*--------------------------------------------------------------------------------------*/
4919 PerlIO_getname(PerlIO *f, char *buf)
4924 bool exported = FALSE;
4925 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
4927 stdio = PerlIO_exportFILE(f,0);
4931 name = fgetname(stdio, buf);
4932 if (exported) PerlIO_releaseFILE(f,stdio);
4937 PERL_UNUSED_ARG(buf);
4938 Perl_croak(aTHX_ "Don't know how to get file name");
4944 /*--------------------------------------------------------------------------------------*/
4946 * Functions which can be called on any kind of PerlIO implemented in
4950 #undef PerlIO_fdopen
4952 PerlIO_fdopen(int fd, const char *mode)
4955 return PerlIO_openn(aTHX_ NULL, mode, fd, 0, 0, NULL, 0, NULL);
4960 PerlIO_open(const char *path, const char *mode)
4963 SV *name = sv_2mortal(newSVpv(path, 0));
4964 return PerlIO_openn(aTHX_ NULL, mode, -1, 0, 0, NULL, 1, &name);
4967 #undef Perlio_reopen
4969 PerlIO_reopen(const char *path, const char *mode, PerlIO *f)
4972 SV *name = sv_2mortal(newSVpv(path,0));
4973 return PerlIO_openn(aTHX_ NULL, mode, -1, 0, 0, f, 1, &name);
4978 PerlIO_getc(PerlIO *f)
4982 if ( 1 == PerlIO_read(f, buf, 1) ) {
4983 return (unsigned char) buf[0];
4988 #undef PerlIO_ungetc
4990 PerlIO_ungetc(PerlIO *f, int ch)
4995 if (PerlIO_unread(f, &buf, 1) == 1)
5003 PerlIO_putc(PerlIO *f, int ch)
5007 return PerlIO_write(f, &buf, 1);
5012 PerlIO_puts(PerlIO *f, const char *s)
5015 return PerlIO_write(f, s, strlen(s));
5018 #undef PerlIO_rewind
5020 PerlIO_rewind(PerlIO *f)
5023 PerlIO_seek(f, (Off_t) 0, SEEK_SET);
5027 #undef PerlIO_vprintf
5029 PerlIO_vprintf(PerlIO *f, const char *fmt, va_list ap)
5032 SV * const sv = newSVpvs("");
5038 Perl_va_copy(ap, apc);
5039 sv_vcatpvf(sv, fmt, &apc);
5041 sv_vcatpvf(sv, fmt, &ap);
5043 s = SvPV_const(sv, len);
5044 wrote = PerlIO_write(f, s, len);
5049 #undef PerlIO_printf
5051 PerlIO_printf(PerlIO *f, const char *fmt, ...)
5056 result = PerlIO_vprintf(f, fmt, ap);
5061 #undef PerlIO_stdoutf
5063 PerlIO_stdoutf(const char *fmt, ...)
5069 result = PerlIO_vprintf(PerlIO_stdout(), fmt, ap);
5074 #undef PerlIO_tmpfile
5076 PerlIO_tmpfile(void)
5081 const int fd = win32_tmpfd();
5083 f = PerlIO_fdopen(fd, "w+b");
5085 # if defined(HAS_MKSTEMP) && ! defined(VMS) && ! defined(OS2)
5086 SV * const sv = newSVpvs("/tmp/PerlIO_XXXXXX");
5088 * I have no idea how portable mkstemp() is ... NI-S
5090 const int fd = mkstemp(SvPVX(sv));
5092 f = PerlIO_fdopen(fd, "w+");
5094 PerlIOBase(f)->flags |= PERLIO_F_TEMP;
5095 PerlLIO_unlink(SvPVX_const(sv));
5098 # else /* !HAS_MKSTEMP, fallback to stdio tmpfile(). */
5099 FILE * const stdio = PerlSIO_tmpfile();
5102 f = PerlIO_fdopen(fileno(stdio), "w+");
5104 # endif /* else HAS_MKSTEMP */
5105 #endif /* else WIN32 */
5112 #endif /* USE_SFIO */
5113 #endif /* PERLIO_IS_STDIO */
5115 /*======================================================================================*/
5117 * Now some functions in terms of above which may be needed even if we are
5118 * not in true PerlIO mode
5121 Perl_PerlIO_context_layers(pTHX_ const char *mode)
5124 const char *direction = NULL;
5127 * Need to supply default layer info from open.pm
5133 if (mode && mode[0] != 'r') {
5134 if (PL_curcop->cop_hints & HINT_LEXICAL_IO_OUT)
5135 direction = "open>";
5137 if (PL_curcop->cop_hints & HINT_LEXICAL_IO_IN)
5138 direction = "open<";
5143 layers = Perl_refcounted_he_fetch(aTHX_ PL_curcop->cop_hints_hash,
5144 0, direction, 5, 0, 0);
5147 return SvOK(layers) ? SvPV_nolen_const(layers) : NULL;
5152 #undef PerlIO_setpos
5154 PerlIO_setpos(PerlIO *f, SV *pos)
5159 const Off_t * const posn = (Off_t *) SvPV(pos, len);
5160 if (f && len == sizeof(Off_t))
5161 return PerlIO_seek(f, *posn, SEEK_SET);
5163 SETERRNO(EINVAL, SS_IVCHAN);
5167 #undef PerlIO_setpos
5169 PerlIO_setpos(PerlIO *f, SV *pos)
5174 Fpos_t * const fpos = (Fpos_t *) SvPV(pos, len);
5175 if (f && len == sizeof(Fpos_t)) {
5176 #if defined(USE_64_BIT_STDIO) && defined(USE_FSETPOS64)
5177 return fsetpos64(f, fpos);
5179 return fsetpos(f, fpos);
5183 SETERRNO(EINVAL, SS_IVCHAN);
5189 #undef PerlIO_getpos
5191 PerlIO_getpos(PerlIO *f, SV *pos)
5194 Off_t posn = PerlIO_tell(f);
5195 sv_setpvn(pos, (char *) &posn, sizeof(posn));
5196 return (posn == (Off_t) - 1) ? -1 : 0;
5199 #undef PerlIO_getpos
5201 PerlIO_getpos(PerlIO *f, SV *pos)
5206 #if defined(USE_64_BIT_STDIO) && defined(USE_FSETPOS64)
5207 code = fgetpos64(f, &fpos);
5209 code = fgetpos(f, &fpos);
5211 sv_setpvn(pos, (char *) &fpos, sizeof(fpos));
5216 #if (defined(PERLIO_IS_STDIO) || !defined(USE_SFIO)) && !defined(HAS_VPRINTF)
5219 vprintf(char *pat, char *args)
5221 _doprnt(pat, args, stdout);
5222 return 0; /* wrong, but perl doesn't use the return
5227 vfprintf(FILE *fd, char *pat, char *args)
5229 _doprnt(pat, args, fd);
5230 return 0; /* wrong, but perl doesn't use the return
5236 #ifndef PerlIO_vsprintf
5238 PerlIO_vsprintf(char *s, int n, const char *fmt, va_list ap)
5241 const int val = my_vsnprintf(s, n > 0 ? n : 0, fmt, ap);
5242 PERL_UNUSED_CONTEXT;
5244 #ifndef PERL_MY_VSNPRINTF_GUARDED
5245 if (val < 0 || (n > 0 ? val >= n : 0)) {
5246 Perl_croak(aTHX_ "panic: my_vsnprintf overflow in PerlIO_vsprintf\n");
5253 #ifndef PerlIO_sprintf
5255 PerlIO_sprintf(char *s, int n, const char *fmt, ...)
5260 result = PerlIO_vsprintf(s, n, fmt, ap);
5268 * c-indentation-style: bsd
5270 * indent-tabs-mode: t
5273 * ex: set ts=8 sts=4 sw=4 noet: