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);
2271 if (PerlIOBase(o)->flags & PERLIO_F_UTF8)
2272 PerlIOBase(f)->flags |= PERLIO_F_UTF8;
2279 /* PL_perlio_fd_refcnt[] is in intrpvar.h */
2281 /* Must be called with PL_perlio_mutex locked. */
2283 S_more_refcounted_fds(pTHX_ const int new_fd) {
2285 const int old_max = PL_perlio_fd_refcnt_size;
2286 const int new_max = 16 + (new_fd & ~15);
2289 PerlIO_debug("More fds - old=%d, need %d, new=%d\n",
2290 old_max, new_fd, new_max);
2292 if (new_fd < old_max) {
2296 assert (new_max > new_fd);
2298 /* Use plain realloc() since we need this memory to be really
2299 * global and visible to all the interpreters and/or threads. */
2300 new_array = (int*) realloc(PL_perlio_fd_refcnt, new_max * sizeof(int));
2304 MUTEX_UNLOCK(&PL_perlio_mutex);
2306 /* Can't use PerlIO to write as it allocates memory */
2307 PerlLIO_write(PerlIO_fileno(Perl_error_log),
2308 PL_no_mem, strlen(PL_no_mem));
2312 PL_perlio_fd_refcnt_size = new_max;
2313 PL_perlio_fd_refcnt = new_array;
2315 PerlIO_debug("Zeroing %p, %d\n",
2316 (void*)(new_array + old_max),
2319 Zero(new_array + old_max, new_max - old_max, int);
2326 /* MUTEX_INIT(&PL_perlio_mutex) is done in PERL_SYS_INIT3(). */
2327 PERL_UNUSED_CONTEXT;
2331 PerlIOUnix_refcnt_inc(int fd)
2338 MUTEX_LOCK(&PL_perlio_mutex);
2340 if (fd >= PL_perlio_fd_refcnt_size)
2341 S_more_refcounted_fds(aTHX_ fd);
2343 PL_perlio_fd_refcnt[fd]++;
2344 if (PL_perlio_fd_refcnt[fd] <= 0) {
2345 Perl_croak(aTHX_ "refcnt_inc: fd %d: %d <= 0\n",
2346 fd, PL_perlio_fd_refcnt[fd]);
2348 PerlIO_debug("refcnt_inc: fd %d refcnt=%d\n",
2349 fd, PL_perlio_fd_refcnt[fd]);
2352 MUTEX_UNLOCK(&PL_perlio_mutex);
2355 Perl_croak(aTHX_ "refcnt_inc: fd %d < 0\n", fd);
2360 PerlIOUnix_refcnt_dec(int fd)
2367 MUTEX_LOCK(&PL_perlio_mutex);
2369 if (fd >= PL_perlio_fd_refcnt_size) {
2370 Perl_croak(aTHX_ "refcnt_dec: fd %d >= refcnt_size %d\n",
2371 fd, PL_perlio_fd_refcnt_size);
2373 if (PL_perlio_fd_refcnt[fd] <= 0) {
2374 Perl_croak(aTHX_ "refcnt_dec: fd %d: %d <= 0\n",
2375 fd, PL_perlio_fd_refcnt[fd]);
2377 cnt = --PL_perlio_fd_refcnt[fd];
2378 PerlIO_debug("refcnt_dec: fd %d refcnt=%d\n", fd, cnt);
2380 MUTEX_UNLOCK(&PL_perlio_mutex);
2383 Perl_croak(aTHX_ "refcnt_dec: fd %d < 0\n", fd);
2389 PerlIO_cleanup(pTHX)
2394 PerlIO_debug("Cleanup layers for %p\n",(void*)aTHX);
2396 PerlIO_debug("Cleanup layers\n");
2399 /* Raise STDIN..STDERR refcount so we don't close them */
2400 for (i=0; i < 3; i++)
2401 PerlIOUnix_refcnt_inc(i);
2402 PerlIO_cleantable(aTHX_ &PL_perlio);
2403 /* Restore STDIN..STDERR refcount */
2404 for (i=0; i < 3; i++)
2405 PerlIOUnix_refcnt_dec(i);
2407 if (PL_known_layers) {
2408 PerlIO_list_free(aTHX_ PL_known_layers);
2409 PL_known_layers = NULL;
2411 if (PL_def_layerlist) {
2412 PerlIO_list_free(aTHX_ PL_def_layerlist);
2413 PL_def_layerlist = NULL;
2417 void PerlIO_teardown(pTHX) /* Call only from PERL_SYS_TERM(). */
2422 /* By now all filehandles should have been closed, so any
2423 * stray (non-STD-)filehandles indicate *possible* (PerlIO)
2426 for (i = 3; i < PL_perlio_fd_refcnt_size; i++) {
2427 if (PL_perlio_fd_refcnt[i])
2428 PerlIO_debug("PerlIO_cleanup: fd %d refcnt=%d\n",
2429 i, PL_perlio_fd_refcnt[i]);
2433 /* Not bothering with PL_perlio_mutex since by now
2434 * all the interpreters are gone. */
2435 if (PL_perlio_fd_refcnt_size /* Assuming initial size of zero. */
2436 && PL_perlio_fd_refcnt) {
2437 free(PL_perlio_fd_refcnt); /* To match realloc() in S_more_refcounted_fds(). */
2438 PL_perlio_fd_refcnt = NULL;
2439 PL_perlio_fd_refcnt_size = 0;
2443 /*--------------------------------------------------------------------------------------*/
2445 * Bottom-most level for UNIX-like case
2449 struct _PerlIO base; /* The generic part */
2450 int fd; /* UNIX like file descriptor */
2451 int oflags; /* open/fcntl flags */
2455 PerlIOUnix_oflags(const char *mode)
2458 if (*mode == IoTYPE_IMPLICIT || *mode == IoTYPE_NUMERIC)
2463 if (*++mode == '+') {
2470 oflags = O_CREAT | O_TRUNC;
2471 if (*++mode == '+') {
2480 oflags = O_CREAT | O_APPEND;
2481 if (*++mode == '+') {
2494 else if (*mode == 't') {
2496 oflags &= ~O_BINARY;
2500 * Always open in binary mode
2503 if (*mode || oflags == -1) {
2504 SETERRNO(EINVAL, LIB_INVARG);
2511 PerlIOUnix_fileno(pTHX_ PerlIO *f)
2513 PERL_UNUSED_CONTEXT;
2514 return PerlIOSelf(f, PerlIOUnix)->fd;
2518 PerlIOUnix_setfd(pTHX_ PerlIO *f, int fd, int imode)
2520 PerlIOUnix * const s = PerlIOSelf(f, PerlIOUnix);
2523 if (PerlLIO_fstat(fd, &st) == 0) {
2524 if (!S_ISREG(st.st_mode)) {
2525 PerlIO_debug("%d is not regular file\n",fd);
2526 PerlIOBase(f)->flags |= PERLIO_F_NOTREG;
2529 PerlIO_debug("%d _is_ a regular file\n",fd);
2535 PerlIOUnix_refcnt_inc(fd);
2536 PERL_UNUSED_CONTEXT;
2540 PerlIOUnix_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2542 IV code = PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
2543 if (*PerlIONext(f)) {
2544 /* We never call down so do any pending stuff now */
2545 PerlIO_flush(PerlIONext(f));
2547 * XXX could (or should) we retrieve the oflags from the open file
2548 * handle rather than believing the "mode" we are passed in? XXX
2549 * Should the value on NULL mode be 0 or -1?
2551 PerlIOUnix_setfd(aTHX_ f, PerlIO_fileno(PerlIONext(f)),
2552 mode ? PerlIOUnix_oflags(mode) : -1);
2554 PerlIOBase(f)->flags |= PERLIO_F_OPEN;
2560 PerlIOUnix_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
2562 const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2564 PERL_UNUSED_CONTEXT;
2565 if (PerlIOBase(f)->flags & PERLIO_F_NOTREG) {
2567 SETERRNO(ESPIPE, LIB_INVARG);
2569 SETERRNO(EINVAL, LIB_INVARG);
2573 new_loc = PerlLIO_lseek(fd, offset, whence);
2574 if (new_loc == (Off_t) - 1)
2576 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
2581 PerlIOUnix_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
2582 IV n, const char *mode, int fd, int imode,
2583 int perm, PerlIO *f, int narg, SV **args)
2585 if (PerlIOValid(f)) {
2586 if (PerlIOBase(f)->flags & PERLIO_F_OPEN)
2587 (*PerlIOBase(f)->tab->Close)(aTHX_ f);
2590 if (*mode == IoTYPE_NUMERIC)
2593 imode = PerlIOUnix_oflags(mode);
2597 const char *path = SvPV_nolen_const(*args);
2598 fd = PerlLIO_open3(path, imode, perm);
2602 if (*mode == IoTYPE_IMPLICIT)
2605 f = PerlIO_allocate(aTHX);
2607 if (!PerlIOValid(f)) {
2608 if (!(f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg))) {
2612 PerlIOUnix_setfd(aTHX_ f, fd, imode);
2613 PerlIOBase(f)->flags |= PERLIO_F_OPEN;
2614 if (*mode == IoTYPE_APPEND)
2615 PerlIOUnix_seek(aTHX_ f, 0, SEEK_END);
2622 * FIXME: pop layers ???
2630 PerlIOUnix_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2632 const PerlIOUnix * const os = PerlIOSelf(o, PerlIOUnix);
2634 if (flags & PERLIO_DUP_FD) {
2635 fd = PerlLIO_dup(fd);
2638 f = PerlIOBase_dup(aTHX_ f, o, param, flags);
2640 /* If all went well overwrite fd in dup'ed lay with the dup()'ed fd */
2641 PerlIOUnix_setfd(aTHX_ f, fd, os->oflags);
2650 PerlIOUnix_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
2653 const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2654 #ifdef PERLIO_STD_SPECIAL
2656 return PERLIO_STD_IN(fd, vbuf, count);
2658 if (!(PerlIOBase(f)->flags & PERLIO_F_CANREAD) ||
2659 PerlIOBase(f)->flags & (PERLIO_F_EOF|PERLIO_F_ERROR)) {
2663 const SSize_t len = PerlLIO_read(fd, vbuf, count);
2664 if (len >= 0 || errno != EINTR) {
2666 if (errno != EAGAIN) {
2667 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2670 else if (len == 0 && count != 0) {
2671 PerlIOBase(f)->flags |= PERLIO_F_EOF;
2682 PerlIOUnix_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
2685 const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2686 #ifdef PERLIO_STD_SPECIAL
2687 if (fd == 1 || fd == 2)
2688 return PERLIO_STD_OUT(fd, vbuf, count);
2691 const SSize_t len = PerlLIO_write(fd, vbuf, count);
2692 if (len >= 0 || errno != EINTR) {
2694 if (errno != EAGAIN) {
2695 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2706 PerlIOUnix_tell(pTHX_ PerlIO *f)
2708 PERL_UNUSED_CONTEXT;
2710 return PerlLIO_lseek(PerlIOSelf(f, PerlIOUnix)->fd, 0, SEEK_CUR);
2715 PerlIOUnix_close(pTHX_ PerlIO *f)
2718 const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2720 if (PerlIOBase(f)->flags & PERLIO_F_OPEN) {
2721 if (PerlIOUnix_refcnt_dec(fd) > 0) {
2722 PerlIOBase(f)->flags &= ~PERLIO_F_OPEN;
2727 SETERRNO(EBADF,SS_IVCHAN);
2730 while (PerlLIO_close(fd) != 0) {
2731 if (errno != EINTR) {
2738 PerlIOBase(f)->flags &= ~PERLIO_F_OPEN;
2743 PERLIO_FUNCS_DECL(PerlIO_unix) = {
2744 sizeof(PerlIO_funcs),
2751 PerlIOBase_binmode, /* binmode */
2761 PerlIOBase_noop_ok, /* flush */
2762 PerlIOBase_noop_fail, /* fill */
2765 PerlIOBase_clearerr,
2766 PerlIOBase_setlinebuf,
2767 NULL, /* get_base */
2768 NULL, /* get_bufsiz */
2771 NULL, /* set_ptrcnt */
2774 /*--------------------------------------------------------------------------------------*/
2779 #if defined(VMS) && !defined(STDIO_BUFFER_WRITABLE)
2780 /* perl5.8 - This ensures the last minute VMS ungetc fix is not
2781 broken by the last second glibc 2.3 fix
2783 #define STDIO_BUFFER_WRITABLE
2788 struct _PerlIO base;
2789 FILE *stdio; /* The stream */
2793 PerlIOStdio_fileno(pTHX_ PerlIO *f)
2795 PERL_UNUSED_CONTEXT;
2797 if (PerlIOValid(f)) {
2798 FILE * const s = PerlIOSelf(f, PerlIOStdio)->stdio;
2800 return PerlSIO_fileno(s);
2807 PerlIOStdio_mode(const char *mode, char *tmode)
2809 char * const ret = tmode;
2815 #if defined(PERLIO_USING_CRLF) || defined(__CYGWIN__)
2823 PerlIOStdio_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2826 if (PerlIOValid(f) && PerlIOValid(n = PerlIONext(f))) {
2827 PerlIO_funcs * const toptab = PerlIOBase(n)->tab;
2828 if (toptab == tab) {
2829 /* Top is already stdio - pop self (duplicate) and use original */
2830 PerlIO_pop(aTHX_ f);
2833 const int fd = PerlIO_fileno(n);
2836 if (fd >= 0 && (stdio = PerlSIO_fdopen(fd,
2837 mode = PerlIOStdio_mode(mode, tmode)))) {
2838 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2839 /* We never call down so do any pending stuff now */
2840 PerlIO_flush(PerlIONext(f));
2847 return PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
2852 PerlIO_importFILE(FILE *stdio, const char *mode)
2858 if (!mode || !*mode) {
2859 /* We need to probe to see how we can open the stream
2860 so start with read/write and then try write and read
2861 we dup() so that we can fclose without loosing the fd.
2863 Note that the errno value set by a failing fdopen
2864 varies between stdio implementations.
2866 const int fd = PerlLIO_dup(fileno(stdio));
2867 FILE *f2 = PerlSIO_fdopen(fd, (mode = "r+"));
2869 f2 = PerlSIO_fdopen(fd, (mode = "w"));
2872 f2 = PerlSIO_fdopen(fd, (mode = "r"));
2875 /* Don't seem to be able to open */
2881 if ((f = PerlIO_push(aTHX_(f = PerlIO_allocate(aTHX)), PERLIO_FUNCS_CAST(&PerlIO_stdio), mode, NULL))) {
2882 s = PerlIOSelf(f, PerlIOStdio);
2884 PerlIOUnix_refcnt_inc(fileno(stdio));
2891 PerlIOStdio_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
2892 IV n, const char *mode, int fd, int imode,
2893 int perm, PerlIO *f, int narg, SV **args)
2896 if (PerlIOValid(f)) {
2897 const char * const path = SvPV_nolen_const(*args);
2898 PerlIOStdio * const s = PerlIOSelf(f, PerlIOStdio);
2900 PerlIOUnix_refcnt_dec(fileno(s->stdio));
2901 stdio = PerlSIO_freopen(path, (mode = PerlIOStdio_mode(mode, tmode)),
2906 PerlIOUnix_refcnt_inc(fileno(s->stdio));
2911 const char * const path = SvPV_nolen_const(*args);
2912 if (*mode == IoTYPE_NUMERIC) {
2914 fd = PerlLIO_open3(path, imode, perm);
2918 bool appended = FALSE;
2920 /* Cygwin wants its 'b' early. */
2922 mode = PerlIOStdio_mode(mode, tmode);
2924 stdio = PerlSIO_fopen(path, mode);
2927 f = PerlIO_allocate(aTHX);
2930 mode = PerlIOStdio_mode(mode, tmode);
2931 f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg);
2933 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2934 PerlIOUnix_refcnt_inc(fileno(stdio));
2936 PerlSIO_fclose(stdio);
2948 if (*mode == IoTYPE_IMPLICIT) {
2955 stdio = PerlSIO_stdin;
2958 stdio = PerlSIO_stdout;
2961 stdio = PerlSIO_stderr;
2966 stdio = PerlSIO_fdopen(fd, mode =
2967 PerlIOStdio_mode(mode, tmode));
2971 f = PerlIO_allocate(aTHX);
2973 if ((f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg))) {
2974 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2975 PerlIOUnix_refcnt_inc(fileno(stdio));
2985 PerlIOStdio_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2987 /* This assumes no layers underneath - which is what
2988 happens, but is not how I remember it. NI-S 2001/10/16
2990 if ((f = PerlIOBase_dup(aTHX_ f, o, param, flags))) {
2991 FILE *stdio = PerlIOSelf(o, PerlIOStdio)->stdio;
2992 const int fd = fileno(stdio);
2994 if (flags & PERLIO_DUP_FD) {
2995 const int dfd = PerlLIO_dup(fileno(stdio));
2997 stdio = PerlSIO_fdopen(dfd, PerlIO_modestr(o,mode));
3002 /* FIXME: To avoid messy error recovery if dup fails
3003 re-use the existing stdio as though flag was not set
3007 stdio = PerlSIO_fdopen(fd, PerlIO_modestr(o,mode));
3009 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
3010 PerlIOUnix_refcnt_inc(fileno(stdio));
3016 PerlIOStdio_invalidate_fileno(pTHX_ FILE *f)
3018 PERL_UNUSED_CONTEXT;
3020 /* XXX this could use PerlIO_canset_fileno() and
3021 * PerlIO_set_fileno() support from Configure
3023 # if defined(__UCLIBC__)
3024 /* uClibc must come before glibc because it defines __GLIBC__ as well. */
3027 # elif defined(__GLIBC__)
3028 /* There may be a better way for GLIBC:
3029 - libio.h defines a flag to not close() on cleanup
3033 # elif defined(__sun__)
3036 # elif defined(__hpux)
3040 /* Next one ->_file seems to be a reasonable fallback, i.e. if
3041 your platform does not have special entry try this one.
3042 [For OSF only have confirmation for Tru64 (alpha)
3043 but assume other OSFs will be similar.]
3045 # elif defined(_AIX) || defined(__osf__) || defined(__irix__)
3048 # elif defined(__FreeBSD__)
3049 /* There may be a better way on FreeBSD:
3050 - we could insert a dummy func in the _close function entry
3051 f->_close = (int (*)(void *)) dummy_close;
3055 # elif defined(__OpenBSD__)
3056 /* There may be a better way on OpenBSD:
3057 - we could insert a dummy func in the _close function entry
3058 f->_close = (int (*)(void *)) dummy_close;
3062 # elif defined(__EMX__)
3063 /* f->_flags &= ~_IOOPEN; */ /* Will leak stream->_buffer */
3066 # elif defined(__CYGWIN__)
3067 /* There may be a better way on CYGWIN:
3068 - we could insert a dummy func in the _close function entry
3069 f->_close = (int (*)(void *)) dummy_close;
3073 # elif defined(WIN32)
3074 # if defined(__BORLANDC__)
3075 f->fd = PerlLIO_dup(fileno(f));
3076 # elif defined(UNDER_CE)
3077 /* WIN_CE does not have access to FILE internals, it hardly has FILE
3086 /* Sarathy's code did this - we fall back to a dup/dup2 hack
3087 (which isn't thread safe) instead
3089 # error "Don't know how to set FILE.fileno on your platform"
3097 PerlIOStdio_close(pTHX_ PerlIO *f)
3099 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3105 const int fd = fileno(stdio);
3110 #ifdef SOCKS5_VERSION_NAME
3111 /* Socks lib overrides close() but stdio isn't linked to
3112 that library (though we are) - so we must call close()
3113 on sockets on stdio's behalf.
3116 Sock_size_t optlen = sizeof(int);
3117 if (getsockopt(fd, SOL_SOCKET, SO_TYPE, (void *) &optval, &optlen) == 0)
3120 if (PerlIOUnix_refcnt_dec(fd) > 0) /* File descriptor still in use */
3123 /* For STD* handles, don't close stdio, since we shared the FILE *, too. */
3124 if (stdio == stdin) /* Some stdios are buggy fflush-ing inputs */
3126 if (stdio == stdout || stdio == stderr)
3127 return PerlIO_flush(f);
3128 /* Tricky - must fclose(stdio) to free memory but not close(fd)
3129 Use Sarathy's trick from maint-5.6 to invalidate the
3130 fileno slot of the FILE *
3132 result = PerlIO_flush(f);
3134 invalidate = PerlIOStdio_invalidate_fileno(aTHX_ stdio);
3136 dupfd = PerlLIO_dup(fd);
3138 result = PerlSIO_fclose(stdio);
3139 /* We treat error from stdio as success if we invalidated
3140 errno may NOT be expected EBADF
3142 if (invalidate && result != 0) {
3146 #ifdef SOCKS5_VERSION_NAME
3147 /* in SOCKS' case, let close() determine return value */
3151 PerlLIO_dup2(dupfd,fd);
3152 PerlLIO_close(dupfd);
3159 PerlIOStdio_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
3162 FILE * const s = PerlIOSelf(f, PerlIOStdio)->stdio;
3166 STDCHAR *buf = (STDCHAR *) vbuf;
3168 * Perl is expecting PerlIO_getc() to fill the buffer Linux's
3169 * stdio does not do that for fread()
3171 const int ch = PerlSIO_fgetc(s);
3178 got = PerlSIO_fread(vbuf, 1, count, s);
3179 if (got == 0 && PerlSIO_ferror(s))
3181 if (got >= 0 || errno != EINTR)
3184 SETERRNO(0,0); /* just in case */
3190 PerlIOStdio_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3193 FILE * const s = PerlIOSelf(f, PerlIOStdio)->stdio;
3195 #ifdef STDIO_BUFFER_WRITABLE
3196 if (PerlIO_fast_gets(f) && PerlIO_has_base(f)) {
3197 STDCHAR *buf = ((STDCHAR *) vbuf) + count;
3198 STDCHAR *base = PerlIO_get_base(f);
3199 SSize_t cnt = PerlIO_get_cnt(f);
3200 STDCHAR *ptr = PerlIO_get_ptr(f);
3201 SSize_t avail = ptr - base;
3203 if (avail > count) {
3207 Move(buf-avail,ptr,avail,STDCHAR);
3210 PerlIO_set_ptrcnt(f,ptr,cnt+avail);
3211 if (PerlSIO_feof(s) && unread >= 0)
3212 PerlSIO_clearerr(s);
3217 if (PerlIO_has_cntptr(f)) {
3218 /* We can get pointer to buffer but not its base
3219 Do ungetc() but check chars are ending up in the
3222 STDCHAR *eptr = (STDCHAR*)PerlSIO_get_ptr(s);
3223 STDCHAR *buf = ((STDCHAR *) vbuf) + count;
3225 const int ch = *--buf & 0xFF;
3226 if (ungetc(ch,s) != ch) {
3227 /* ungetc did not work */
3230 if ((STDCHAR*)PerlSIO_get_ptr(s) != --eptr || ((*eptr & 0xFF) != ch)) {
3231 /* Did not change pointer as expected */
3232 fgetc(s); /* get char back again */
3242 unread += PerlIOBase_unread(aTHX_ f, vbuf, count);
3248 PerlIOStdio_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3253 got = PerlSIO_fwrite(vbuf, 1, count,
3254 PerlIOSelf(f, PerlIOStdio)->stdio);
3255 if (got >= 0 || errno != EINTR)
3258 SETERRNO(0,0); /* just in case */
3264 PerlIOStdio_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3266 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3267 PERL_UNUSED_CONTEXT;
3269 return PerlSIO_fseek(stdio, offset, whence);
3273 PerlIOStdio_tell(pTHX_ PerlIO *f)
3275 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3276 PERL_UNUSED_CONTEXT;
3278 return PerlSIO_ftell(stdio);
3282 PerlIOStdio_flush(pTHX_ PerlIO *f)
3284 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3285 PERL_UNUSED_CONTEXT;
3287 if (PerlIOBase(f)->flags & PERLIO_F_CANWRITE) {
3288 return PerlSIO_fflush(stdio);
3294 * FIXME: This discards ungetc() and pre-read stuff which is not
3295 * right if this is just a "sync" from a layer above Suspect right
3296 * design is to do _this_ but not have layer above flush this
3297 * layer read-to-read
3300 * Not writeable - sync by attempting a seek
3302 const int err = errno;
3303 if (PerlSIO_fseek(stdio, (Off_t) 0, SEEK_CUR) != 0)
3311 PerlIOStdio_eof(pTHX_ PerlIO *f)
3313 PERL_UNUSED_CONTEXT;
3315 return PerlSIO_feof(PerlIOSelf(f, PerlIOStdio)->stdio);
3319 PerlIOStdio_error(pTHX_ PerlIO *f)
3321 PERL_UNUSED_CONTEXT;
3323 return PerlSIO_ferror(PerlIOSelf(f, PerlIOStdio)->stdio);
3327 PerlIOStdio_clearerr(pTHX_ PerlIO *f)
3329 PERL_UNUSED_CONTEXT;
3331 PerlSIO_clearerr(PerlIOSelf(f, PerlIOStdio)->stdio);
3335 PerlIOStdio_setlinebuf(pTHX_ PerlIO *f)
3337 PERL_UNUSED_CONTEXT;
3339 #ifdef HAS_SETLINEBUF
3340 PerlSIO_setlinebuf(PerlIOSelf(f, PerlIOStdio)->stdio);
3342 PerlSIO_setvbuf(PerlIOSelf(f, PerlIOStdio)->stdio, NULL, _IOLBF, 0);
3348 PerlIOStdio_get_base(pTHX_ PerlIO *f)
3350 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3351 return (STDCHAR*)PerlSIO_get_base(stdio);
3355 PerlIOStdio_get_bufsiz(pTHX_ PerlIO *f)
3357 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3358 return PerlSIO_get_bufsiz(stdio);
3362 #ifdef USE_STDIO_PTR
3364 PerlIOStdio_get_ptr(pTHX_ PerlIO *f)
3366 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3367 return (STDCHAR*)PerlSIO_get_ptr(stdio);
3371 PerlIOStdio_get_cnt(pTHX_ PerlIO *f)
3373 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3374 return PerlSIO_get_cnt(stdio);
3378 PerlIOStdio_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
3380 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3382 #ifdef STDIO_PTR_LVALUE
3383 PerlSIO_set_ptr(stdio, ptr); /* LHS STDCHAR* cast non-portable */
3384 #ifdef STDIO_PTR_LVAL_SETS_CNT
3385 if (PerlSIO_get_cnt(stdio) != (cnt)) {
3386 assert(PerlSIO_get_cnt(stdio) == (cnt));
3389 #if (!defined(STDIO_PTR_LVAL_NOCHANGE_CNT))
3391 * Setting ptr _does_ change cnt - we are done
3395 #else /* STDIO_PTR_LVALUE */
3397 #endif /* STDIO_PTR_LVALUE */
3400 * Now (or only) set cnt
3402 #ifdef STDIO_CNT_LVALUE
3403 PerlSIO_set_cnt(stdio, cnt);
3404 #else /* STDIO_CNT_LVALUE */
3405 #if (defined(STDIO_PTR_LVALUE) && defined(STDIO_PTR_LVAL_SETS_CNT))
3406 PerlSIO_set_ptr(stdio,
3407 PerlSIO_get_ptr(stdio) + (PerlSIO_get_cnt(stdio) -
3409 #else /* STDIO_PTR_LVAL_SETS_CNT */
3411 #endif /* STDIO_PTR_LVAL_SETS_CNT */
3412 #endif /* STDIO_CNT_LVALUE */
3419 PerlIOStdio_fill(pTHX_ PerlIO *f)
3421 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3423 PERL_UNUSED_CONTEXT;
3426 * fflush()ing read-only streams can cause trouble on some stdio-s
3428 if ((PerlIOBase(f)->flags & PERLIO_F_CANWRITE)) {
3429 if (PerlSIO_fflush(stdio) != 0)
3433 c = PerlSIO_fgetc(stdio);
3436 if (! PerlSIO_ferror(stdio) || errno != EINTR)
3442 #if (defined(STDIO_PTR_LVALUE) && (defined(STDIO_CNT_LVALUE) || defined(STDIO_PTR_LVAL_SETS_CNT)))
3444 #ifdef STDIO_BUFFER_WRITABLE
3445 if (PerlIO_fast_gets(f) && PerlIO_has_base(f)) {
3446 /* Fake ungetc() to the real buffer in case system's ungetc
3449 STDCHAR *base = (STDCHAR*)PerlSIO_get_base(stdio);
3450 SSize_t cnt = PerlSIO_get_cnt(stdio);
3451 STDCHAR *ptr = (STDCHAR*)PerlSIO_get_ptr(stdio);
3452 if (ptr == base+1) {
3453 *--ptr = (STDCHAR) c;
3454 PerlIOStdio_set_ptrcnt(aTHX_ f,ptr,cnt+1);
3455 if (PerlSIO_feof(stdio))
3456 PerlSIO_clearerr(stdio);
3462 if (PerlIO_has_cntptr(f)) {
3464 if (PerlIOStdio_unread(aTHX_ f,&ch,1) == 1) {
3471 /* An ungetc()d char is handled separately from the regular
3472 * buffer, so we stuff it in the buffer ourselves.
3473 * Should never get called as should hit code above
3475 *(--((*stdio)->_ptr)) = (unsigned char) c;
3478 /* If buffer snoop scheme above fails fall back to
3481 if (PerlSIO_ungetc(c, stdio) != c)
3489 PERLIO_FUNCS_DECL(PerlIO_stdio) = {
3490 sizeof(PerlIO_funcs),
3492 sizeof(PerlIOStdio),
3493 PERLIO_K_BUFFERED|PERLIO_K_RAW,
3497 PerlIOBase_binmode, /* binmode */
3511 PerlIOStdio_clearerr,
3512 PerlIOStdio_setlinebuf,
3514 PerlIOStdio_get_base,
3515 PerlIOStdio_get_bufsiz,
3520 #ifdef USE_STDIO_PTR
3521 PerlIOStdio_get_ptr,
3522 PerlIOStdio_get_cnt,
3523 # if defined(HAS_FAST_STDIO) && defined(USE_FAST_STDIO)
3524 PerlIOStdio_set_ptrcnt,
3527 # endif /* HAS_FAST_STDIO && USE_FAST_STDIO */
3532 #endif /* USE_STDIO_PTR */
3535 /* Note that calls to PerlIO_exportFILE() are reversed using
3536 * PerlIO_releaseFILE(), not importFILE. */
3538 PerlIO_exportFILE(PerlIO * f, const char *mode)
3542 if (PerlIOValid(f)) {
3545 if (!mode || !*mode) {
3546 mode = PerlIO_modestr(f, buf);
3548 stdio = PerlSIO_fdopen(PerlIO_fileno(f), mode);
3552 /* De-link any lower layers so new :stdio sticks */
3554 if ((f2 = PerlIO_push(aTHX_ f, PERLIO_FUNCS_CAST(&PerlIO_stdio), buf, NULL))) {
3555 PerlIOStdio *s = PerlIOSelf((f = f2), PerlIOStdio);
3557 PerlIOUnix_refcnt_inc(fileno(stdio));
3558 /* Link previous lower layers under new one */
3562 /* restore layers list */
3572 PerlIO_findFILE(PerlIO *f)
3576 if (l->tab == &PerlIO_stdio) {
3577 PerlIOStdio *s = PerlIOSelf(&l, PerlIOStdio);
3580 l = *PerlIONext(&l);
3582 /* Uses fallback "mode" via PerlIO_modestr() in PerlIO_exportFILE */
3583 return PerlIO_exportFILE(f, NULL);
3586 /* Use this to reverse PerlIO_exportFILE calls. */
3588 PerlIO_releaseFILE(PerlIO *p, FILE *f)
3593 if (l->tab == &PerlIO_stdio) {
3594 PerlIOStdio *s = PerlIOSelf(&l, PerlIOStdio);
3595 if (s->stdio == f) {
3597 const int fd = fileno(f);
3599 PerlIOUnix_refcnt_dec(fd);
3600 PerlIO_pop(aTHX_ p);
3609 /*--------------------------------------------------------------------------------------*/
3611 * perlio buffer layer
3615 PerlIOBuf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
3617 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3618 const int fd = PerlIO_fileno(f);
3619 if (fd >= 0 && PerlLIO_isatty(fd)) {
3620 PerlIOBase(f)->flags |= PERLIO_F_LINEBUF | PERLIO_F_TTY;
3622 if (*PerlIONext(f)) {
3623 const Off_t posn = PerlIO_tell(PerlIONext(f));
3624 if (posn != (Off_t) - 1) {
3628 return PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
3632 PerlIOBuf_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
3633 IV n, const char *mode, int fd, int imode, int perm,
3634 PerlIO *f, int narg, SV **args)
3636 if (PerlIOValid(f)) {
3637 PerlIO *next = PerlIONext(f);
3639 PerlIO_layer_fetch(aTHX_ layers, n - 1, PerlIOBase(next)->tab);
3640 if (tab && tab->Open)
3642 (*tab->Open)(aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
3644 if (!next || (*PerlIOBase(f)->tab->Pushed) (aTHX_ f, mode, PerlIOArg, self) != 0) {
3649 PerlIO_funcs *tab = PerlIO_layer_fetch(aTHX_ layers, n - 1, PerlIO_default_btm());
3651 if (*mode == IoTYPE_IMPLICIT) {
3657 if (tab && tab->Open)
3658 f = (*tab->Open)(aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
3661 SETERRNO(EINVAL, LIB_INVARG);
3663 if (PerlIO_push(aTHX_ f, self, mode, PerlIOArg) == 0) {
3665 * if push fails during open, open fails. close will pop us.
3670 fd = PerlIO_fileno(f);
3671 if (init && fd == 2) {
3673 * Initial stderr is unbuffered
3675 PerlIOBase(f)->flags |= PERLIO_F_UNBUF;
3677 #ifdef PERLIO_USING_CRLF
3678 # ifdef PERLIO_IS_BINMODE_FD
3679 if (PERLIO_IS_BINMODE_FD(fd))
3680 PerlIO_binmode(aTHX_ f, '<'/*not used*/, O_BINARY, NULL);
3684 * do something about failing setmode()? --jhi
3686 PerlLIO_setmode(fd, O_BINARY);
3695 * This "flush" is akin to sfio's sync in that it handles files in either
3696 * read or write state. For write state, we put the postponed data through
3697 * the next layers. For read state, we seek() the next layers to the
3698 * offset given by current position in the buffer, and discard the buffer
3699 * state (XXXX supposed to be for seek()able buffers only, but now it is done
3700 * in any case?). Then the pass the stick further in chain.
3703 PerlIOBuf_flush(pTHX_ PerlIO *f)
3705 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3707 PerlIO *n = PerlIONext(f);
3708 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF) {
3710 * write() the buffer
3712 const STDCHAR *buf = b->buf;
3713 const STDCHAR *p = buf;
3714 while (p < b->ptr) {
3715 SSize_t count = PerlIO_write(n, p, b->ptr - p);
3719 else if (count < 0 || PerlIO_error(n)) {
3720 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
3725 b->posn += (p - buf);
3727 else if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3728 STDCHAR *buf = PerlIO_get_base(f);
3730 * Note position change
3732 b->posn += (b->ptr - buf);
3733 if (b->ptr < b->end) {
3734 /* We did not consume all of it - try and seek downstream to
3735 our logical position
3737 if (PerlIOValid(n) && PerlIO_seek(n, b->posn, SEEK_SET) == 0) {
3738 /* Reload n as some layers may pop themselves on seek */
3739 b->posn = PerlIO_tell(n = PerlIONext(f));
3742 /* Seek failed (e.g. pipe or tty). Do NOT clear buffer or pre-read
3743 data is lost for good - so return saying "ok" having undone
3746 b->posn -= (b->ptr - buf);
3751 b->ptr = b->end = b->buf;
3752 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3753 /* We check for Valid because of dubious decision to make PerlIO_flush(NULL) flush all */
3754 if (PerlIOValid(n) && PerlIO_flush(n) != 0)
3759 /* This discards the content of the buffer after b->ptr, and rereads
3760 * the buffer from the position off in the layer downstream; here off
3761 * is at offset corresponding to b->ptr - b->buf.
3764 PerlIOBuf_fill(pTHX_ PerlIO *f)
3766 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3767 PerlIO *n = PerlIONext(f);
3770 * Down-stream flush is defined not to loose read data so is harmless.
3771 * we would not normally be fill'ing if there was data left in anycase.
3773 if (PerlIO_flush(f) != 0) /* XXXX Check that its seek() succeeded?! */
3775 if (PerlIOBase(f)->flags & PERLIO_F_TTY)
3776 PerlIOBase_flush_linebuf(aTHX);
3779 PerlIO_get_base(f); /* allocate via vtable */
3781 assert(b->buf); /* The b->buf does get allocated via the vtable system. */
3783 b->ptr = b->end = b->buf;
3785 if (!PerlIOValid(n)) {
3786 PerlIOBase(f)->flags |= PERLIO_F_EOF;
3790 if (PerlIO_fast_gets(n)) {
3792 * Layer below is also buffered. We do _NOT_ want to call its
3793 * ->Read() because that will loop till it gets what we asked for
3794 * which may hang on a pipe etc. Instead take anything it has to
3795 * hand, or ask it to fill _once_.
3797 avail = PerlIO_get_cnt(n);
3799 avail = PerlIO_fill(n);
3801 avail = PerlIO_get_cnt(n);
3803 if (!PerlIO_error(n) && PerlIO_eof(n))
3808 STDCHAR *ptr = PerlIO_get_ptr(n);
3809 const SSize_t cnt = avail;
3810 if (avail > (SSize_t)b->bufsiz)
3812 Copy(ptr, b->buf, avail, STDCHAR);
3813 PerlIO_set_ptrcnt(n, ptr + avail, cnt - avail);
3817 avail = PerlIO_read(n, b->ptr, b->bufsiz);
3821 PerlIOBase(f)->flags |= PERLIO_F_EOF;
3823 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
3826 b->end = b->buf + avail;
3827 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3832 PerlIOBuf_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
3834 if (PerlIOValid(f)) {
3835 const PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3838 return PerlIOBase_read(aTHX_ f, vbuf, count);
3844 PerlIOBuf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3846 const STDCHAR *buf = (const STDCHAR *) vbuf + count;
3847 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3850 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
3855 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3857 * Buffer is already a read buffer, we can overwrite any chars
3858 * which have been read back to buffer start
3860 avail = (b->ptr - b->buf);
3864 * Buffer is idle, set it up so whole buffer is available for
3868 b->end = b->buf + avail;
3870 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3872 * Buffer extends _back_ from where we are now
3874 b->posn -= b->bufsiz;
3876 if (avail > (SSize_t) count) {
3878 * If we have space for more than count, just move count
3886 * In simple stdio-like ungetc() case chars will be already
3889 if (buf != b->ptr) {
3890 Copy(buf, b->ptr, avail, STDCHAR);
3894 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
3898 unread += PerlIOBase_unread(aTHX_ f, vbuf, count);
3904 PerlIOBuf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3906 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3907 const STDCHAR *buf = (const STDCHAR *) vbuf;
3908 const STDCHAR *flushptr = buf;
3912 if (!(PerlIOBase(f)->flags & PERLIO_F_CANWRITE))
3914 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3915 if (PerlIO_flush(f) != 0) {
3919 if (PerlIOBase(f)->flags & PERLIO_F_LINEBUF) {
3920 flushptr = buf + count;
3921 while (flushptr > buf && *(flushptr - 1) != '\n')
3925 SSize_t avail = b->bufsiz - (b->ptr - b->buf);
3926 if ((SSize_t) count < avail)
3928 if (flushptr > buf && flushptr <= buf + avail)
3929 avail = flushptr - buf;
3930 PerlIOBase(f)->flags |= PERLIO_F_WRBUF;
3932 Copy(buf, b->ptr, avail, STDCHAR);
3937 if (buf == flushptr)
3940 if (b->ptr >= (b->buf + b->bufsiz))
3943 if (PerlIOBase(f)->flags & PERLIO_F_UNBUF)
3949 PerlIOBuf_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3952 if ((code = PerlIO_flush(f)) == 0) {
3953 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
3954 code = PerlIO_seek(PerlIONext(f), offset, whence);
3956 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3957 b->posn = PerlIO_tell(PerlIONext(f));
3964 PerlIOBuf_tell(pTHX_ PerlIO *f)
3966 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3968 * b->posn is file position where b->buf was read, or will be written
3970 Off_t posn = b->posn;
3971 if ((PerlIOBase(f)->flags & PERLIO_F_APPEND) &&
3972 (PerlIOBase(f)->flags & PERLIO_F_WRBUF)) {
3974 /* As O_APPEND files are normally shared in some sense it is better
3979 /* when file is NOT shared then this is sufficient */
3980 PerlIO_seek(PerlIONext(f),0, SEEK_END);
3982 posn = b->posn = PerlIO_tell(PerlIONext(f));
3986 * If buffer is valid adjust position by amount in buffer
3988 posn += (b->ptr - b->buf);
3994 PerlIOBuf_popped(pTHX_ PerlIO *f)
3996 const IV code = PerlIOBase_popped(aTHX_ f);
3997 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3998 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
4001 b->ptr = b->end = b->buf = NULL;
4002 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
4007 PerlIOBuf_close(pTHX_ PerlIO *f)
4009 const IV code = PerlIOBase_close(aTHX_ f);
4010 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4011 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
4014 b->ptr = b->end = b->buf = NULL;
4015 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
4020 PerlIOBuf_get_ptr(pTHX_ PerlIO *f)
4022 const PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4029 PerlIOBuf_get_cnt(pTHX_ PerlIO *f)
4031 const PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4034 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF)
4035 return (b->end - b->ptr);
4040 PerlIOBuf_get_base(pTHX_ PerlIO *f)
4042 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4043 PERL_UNUSED_CONTEXT;
4048 b->buf = Newxz(b->buf,b->bufsiz, STDCHAR);
4050 b->buf = (STDCHAR *) & b->oneword;
4051 b->bufsiz = sizeof(b->oneword);
4053 b->end = b->ptr = b->buf;
4059 PerlIOBuf_bufsiz(pTHX_ PerlIO *f)
4061 const PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4064 return (b->end - b->buf);
4068 PerlIOBuf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
4070 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4074 if (PerlIO_get_cnt(f) != cnt || b->ptr < b->buf) {
4075 assert(PerlIO_get_cnt(f) == cnt);
4076 assert(b->ptr >= b->buf);
4078 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4082 PerlIOBuf_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
4084 return PerlIOBase_dup(aTHX_ f, o, param, flags);
4089 PERLIO_FUNCS_DECL(PerlIO_perlio) = {
4090 sizeof(PerlIO_funcs),
4093 PERLIO_K_BUFFERED|PERLIO_K_RAW,
4097 PerlIOBase_binmode, /* binmode */
4111 PerlIOBase_clearerr,
4112 PerlIOBase_setlinebuf,
4117 PerlIOBuf_set_ptrcnt,
4120 /*--------------------------------------------------------------------------------------*/
4122 * Temp layer to hold unread chars when cannot do it any other way
4126 PerlIOPending_fill(pTHX_ PerlIO *f)
4129 * Should never happen
4136 PerlIOPending_close(pTHX_ PerlIO *f)
4139 * A tad tricky - flush pops us, then we close new top
4142 return PerlIO_close(f);
4146 PerlIOPending_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
4149 * A tad tricky - flush pops us, then we seek new top
4152 return PerlIO_seek(f, offset, whence);
4157 PerlIOPending_flush(pTHX_ PerlIO *f)
4159 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4160 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
4164 PerlIO_pop(aTHX_ f);
4169 PerlIOPending_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
4175 PerlIOBuf_set_ptrcnt(aTHX_ f, ptr, cnt);
4180 PerlIOPending_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
4182 const IV code = PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
4183 PerlIOl * const l = PerlIOBase(f);
4185 * Our PerlIO_fast_gets must match what we are pushed on, or sv_gets()
4186 * etc. get muddled when it changes mid-string when we auto-pop.
4188 l->flags = (l->flags & ~(PERLIO_F_FASTGETS | PERLIO_F_UTF8)) |
4189 (PerlIOBase(PerlIONext(f))->
4190 flags & (PERLIO_F_FASTGETS | PERLIO_F_UTF8));
4195 PerlIOPending_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
4197 SSize_t avail = PerlIO_get_cnt(f);
4199 if ((SSize_t)count < avail)
4202 got = PerlIOBuf_read(aTHX_ f, vbuf, avail);
4203 if (got >= 0 && got < (SSize_t)count) {
4204 const SSize_t more =
4205 PerlIO_read(f, ((STDCHAR *) vbuf) + got, count - got);
4206 if (more >= 0 || got == 0)
4212 PERLIO_FUNCS_DECL(PerlIO_pending) = {
4213 sizeof(PerlIO_funcs),
4216 PERLIO_K_BUFFERED|PERLIO_K_RAW, /* not sure about RAW here */
4217 PerlIOPending_pushed,
4220 PerlIOBase_binmode, /* binmode */
4229 PerlIOPending_close,
4230 PerlIOPending_flush,
4234 PerlIOBase_clearerr,
4235 PerlIOBase_setlinebuf,
4240 PerlIOPending_set_ptrcnt,
4245 /*--------------------------------------------------------------------------------------*/
4247 * crlf - translation On read translate CR,LF to "\n" we do this by
4248 * overriding ptr/cnt entries to hand back a line at a time and keeping a
4249 * record of which nl we "lied" about. On write translate "\n" to CR,LF
4251 * c->nl points on the first byte of CR LF pair when it is temporarily
4252 * replaced by LF, or to the last CR of the buffer. In the former case
4253 * the caller thinks that the buffer ends at c->nl + 1, in the latter
4254 * that it ends at c->nl; these two cases can be distinguished by
4255 * *c->nl. c->nl is set during _getcnt() call, and unset during
4256 * _unread() and _flush() calls.
4257 * It only matters for read operations.
4261 PerlIOBuf base; /* PerlIOBuf stuff */
4262 STDCHAR *nl; /* Position of crlf we "lied" about in the
4266 /* Inherit the PERLIO_F_UTF8 flag from previous layer.
4267 * Otherwise the :crlf layer would always revert back to
4271 S_inherit_utf8_flag(PerlIO *f)
4273 PerlIO *g = PerlIONext(f);
4274 if (PerlIOValid(g)) {
4275 if (PerlIOBase(g)->flags & PERLIO_F_UTF8) {
4276 PerlIOBase(f)->flags |= PERLIO_F_UTF8;
4282 PerlIOCrlf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
4285 PerlIOBase(f)->flags |= PERLIO_F_CRLF;
4286 code = PerlIOBuf_pushed(aTHX_ f, mode, arg, tab);
4288 PerlIO_debug("PerlIOCrlf_pushed f=%p %s %s fl=%08" UVxf "\n",
4289 (void*)f, PerlIOBase(f)->tab->name, (mode) ? mode : "(Null)",
4290 PerlIOBase(f)->flags);
4293 /* Enable the first CRLF capable layer you can find, but if none
4294 * found, the one we just pushed is fine. This results in at
4295 * any given moment at most one CRLF-capable layer being enabled
4296 * in the whole layer stack. */
4297 PerlIO *g = PerlIONext(f);
4298 while (PerlIOValid(g)) {
4299 PerlIOl *b = PerlIOBase(g);
4300 if (b && b->tab == &PerlIO_crlf) {
4301 if (!(b->flags & PERLIO_F_CRLF))
4302 b->flags |= PERLIO_F_CRLF;
4303 S_inherit_utf8_flag(g);
4304 PerlIO_pop(aTHX_ f);
4310 S_inherit_utf8_flag(f);
4316 PerlIOCrlf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4318 PerlIOCrlf * const c = PerlIOSelf(f, PerlIOCrlf);
4319 if (c->nl) { /* XXXX Shouldn't it be done only if b->ptr > c->nl? */
4323 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF))
4324 return PerlIOBuf_unread(aTHX_ f, vbuf, count);
4326 const STDCHAR *buf = (const STDCHAR *) vbuf + count;
4327 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4329 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
4334 if (!(PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4335 b->end = b->ptr = b->buf + b->bufsiz;
4336 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4337 b->posn -= b->bufsiz;
4339 while (count > 0 && b->ptr > b->buf) {
4340 const int ch = *--buf;
4342 if (b->ptr - 2 >= b->buf) {
4349 /* If b->ptr - 1 == b->buf, we are undoing reading 0xa */
4350 *--(b->ptr) = 0xa; /* Works even if 0xa == '\r' */
4366 /* XXXX This code assumes that buffer size >=2, but does not check it... */
4368 PerlIOCrlf_get_cnt(pTHX_ PerlIO *f)
4370 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4373 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
4374 PerlIOCrlf * const c = PerlIOSelf(f, PerlIOCrlf);
4375 if ((PerlIOBase(f)->flags & PERLIO_F_CRLF) && (!c->nl || *c->nl == 0xd)) {
4376 STDCHAR *nl = (c->nl) ? c->nl : b->ptr;
4378 while (nl < b->end && *nl != 0xd)
4380 if (nl < b->end && *nl == 0xd) {
4382 if (nl + 1 < b->end) {
4389 * Not CR,LF but just CR
4397 * Blast - found CR as last char in buffer
4402 * They may not care, defer work as long as
4406 return (nl - b->ptr);
4410 b->ptr++; /* say we have read it as far as
4411 * flush() is concerned */
4412 b->buf++; /* Leave space in front of buffer */
4413 /* Note as we have moved buf up flush's
4415 will naturally make posn point at CR
4417 b->bufsiz--; /* Buffer is thus smaller */
4418 code = PerlIO_fill(f); /* Fetch some more */
4419 b->bufsiz++; /* Restore size for next time */
4420 b->buf--; /* Point at space */
4421 b->ptr = nl = b->buf; /* Which is what we hand
4423 *nl = 0xd; /* Fill in the CR */
4425 goto test; /* fill() call worked */
4427 * CR at EOF - just fall through
4429 /* Should we clear EOF though ??? */
4434 return (((c->nl) ? (c->nl + 1) : b->end) - b->ptr);
4440 PerlIOCrlf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
4442 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4443 PerlIOCrlf * const c = PerlIOSelf(f, PerlIOCrlf);
4449 if (ptr == b->end && *c->nl == 0xd) {
4450 /* Defered CR at end of buffer case - we lied about count */
4463 * Test code - delete when it works ...
4465 IV flags = PerlIOBase(f)->flags;
4466 STDCHAR *chk = (c->nl) ? (c->nl+1) : b->end;
4467 if (ptr+cnt == c->nl && c->nl+1 == b->end && *c->nl == 0xd) {
4468 /* Defered CR at end of buffer case - we lied about count */
4474 Perl_croak(aTHX_ "ptr wrong %p != %p fl=%08" UVxf
4475 " nl=%p e=%p for %d", (void*)ptr, (void*)chk,
4476 flags, c->nl, b->end, cnt);
4483 * They have taken what we lied about
4491 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4495 PerlIOCrlf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4497 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF))
4498 return PerlIOBuf_write(aTHX_ f, vbuf, count);
4500 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4501 const STDCHAR *buf = (const STDCHAR *) vbuf;
4502 const STDCHAR * const ebuf = buf + count;
4505 if (!(PerlIOBase(f)->flags & PERLIO_F_CANWRITE))
4507 while (buf < ebuf) {
4508 const STDCHAR * const eptr = b->buf + b->bufsiz;
4509 PerlIOBase(f)->flags |= PERLIO_F_WRBUF;
4510 while (buf < ebuf && b->ptr < eptr) {
4512 if ((b->ptr + 2) > eptr) {
4520 *(b->ptr)++ = 0xd; /* CR */
4521 *(b->ptr)++ = 0xa; /* LF */
4523 if (PerlIOBase(f)->flags & PERLIO_F_LINEBUF) {
4530 *(b->ptr)++ = *buf++;
4532 if (b->ptr >= eptr) {
4538 if (PerlIOBase(f)->flags & PERLIO_F_UNBUF)
4540 return (buf - (STDCHAR *) vbuf);
4545 PerlIOCrlf_flush(pTHX_ PerlIO *f)
4547 PerlIOCrlf * const c = PerlIOSelf(f, PerlIOCrlf);
4552 return PerlIOBuf_flush(aTHX_ f);
4556 PerlIOCrlf_binmode(pTHX_ PerlIO *f)
4558 if ((PerlIOBase(f)->flags & PERLIO_F_CRLF)) {
4559 /* In text mode - flush any pending stuff and flip it */
4560 PerlIOBase(f)->flags &= ~PERLIO_F_CRLF;
4561 #ifndef PERLIO_USING_CRLF
4562 /* CRLF is unusual case - if this is just the :crlf layer pop it */
4563 if (PerlIOBase(f)->tab == &PerlIO_crlf) {
4564 PerlIO_pop(aTHX_ f);
4571 PERLIO_FUNCS_DECL(PerlIO_crlf) = {
4572 sizeof(PerlIO_funcs),
4575 PERLIO_K_BUFFERED | PERLIO_K_CANCRLF | PERLIO_K_RAW,
4577 PerlIOBuf_popped, /* popped */
4579 PerlIOCrlf_binmode, /* binmode */
4583 PerlIOBuf_read, /* generic read works with ptr/cnt lies */
4584 PerlIOCrlf_unread, /* Put CR,LF in buffer for each '\n' */
4585 PerlIOCrlf_write, /* Put CR,LF in buffer for each '\n' */
4593 PerlIOBase_clearerr,
4594 PerlIOBase_setlinebuf,
4599 PerlIOCrlf_set_ptrcnt,
4603 /*--------------------------------------------------------------------------------------*/
4605 * mmap as "buffer" layer
4609 PerlIOBuf base; /* PerlIOBuf stuff */
4610 Mmap_t mptr; /* Mapped address */
4611 Size_t len; /* mapped length */
4612 STDCHAR *bbuf; /* malloced buffer if map fails */
4616 PerlIOMmap_map(pTHX_ PerlIO *f)
4619 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4620 const IV flags = PerlIOBase(f)->flags;
4624 if (flags & PERLIO_F_CANREAD) {
4625 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4626 const int fd = PerlIO_fileno(f);
4628 code = Fstat(fd, &st);
4629 if (code == 0 && S_ISREG(st.st_mode)) {
4630 SSize_t len = st.st_size - b->posn;
4633 if (PL_mmap_page_size <= 0)
4634 Perl_croak(aTHX_ "panic: bad pagesize %" IVdf,
4638 * This is a hack - should never happen - open should
4641 b->posn = PerlIO_tell(PerlIONext(f));
4643 posn = (b->posn / PL_mmap_page_size) * PL_mmap_page_size;
4644 len = st.st_size - posn;
4645 m->mptr = (Mmap_t)mmap(NULL, len, PROT_READ, MAP_SHARED, fd, posn);
4646 if (m->mptr && m->mptr != (Mmap_t) - 1) {
4647 #if 0 && defined(HAS_MADVISE) && defined(MADV_SEQUENTIAL)
4648 madvise(m->mptr, len, MADV_SEQUENTIAL);
4650 #if 0 && defined(HAS_MADVISE) && defined(MADV_WILLNEED)
4651 madvise(m->mptr, len, MADV_WILLNEED);
4653 PerlIOBase(f)->flags =
4654 (flags & ~PERLIO_F_EOF) | PERLIO_F_RDBUF;
4655 b->end = ((STDCHAR *) m->mptr) + len;
4656 b->buf = ((STDCHAR *) m->mptr) + (b->posn - posn);
4665 PerlIOBase(f)->flags =
4666 flags | PERLIO_F_EOF | PERLIO_F_RDBUF;
4668 b->ptr = b->end = b->ptr;
4677 PerlIOMmap_unmap(pTHX_ PerlIO *f)
4679 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4682 PerlIOBuf * const b = &m->base;
4684 /* The munmap address argument is tricky: depending on the
4685 * standard it is either "void *" or "caddr_t" (which is
4686 * usually "char *" (signed or unsigned). If we cast it
4687 * to "void *", those that have it caddr_t and an uptight
4688 * C++ compiler, will freak out. But casting it as char*
4689 * should work. Maybe. (Using Mmap_t figured out by
4690 * Configure doesn't always work, apparently.) */
4691 code = munmap((char*)m->mptr, m->len);
4695 if (PerlIO_seek(PerlIONext(f), b->posn, SEEK_SET) != 0)
4698 b->ptr = b->end = b->buf;
4699 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
4705 PerlIOMmap_get_base(pTHX_ PerlIO *f)
4707 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4708 PerlIOBuf * const b = &m->base;
4709 if (b->buf && (PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4711 * Already have a readbuffer in progress
4717 * We have a write buffer or flushed PerlIOBuf read buffer
4719 m->bbuf = b->buf; /* save it in case we need it again */
4720 b->buf = NULL; /* Clear to trigger below */
4723 PerlIOMmap_map(aTHX_ f); /* Try and map it */
4726 * Map did not work - recover PerlIOBuf buffer if we have one
4731 b->ptr = b->end = b->buf;
4734 return PerlIOBuf_get_base(aTHX_ f);
4738 PerlIOMmap_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4740 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4741 PerlIOBuf * const b = &m->base;
4742 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
4744 if (b->ptr && (b->ptr - count) >= b->buf
4745 && memEQ(b->ptr - count, vbuf, count)) {
4747 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
4752 * Loose the unwritable mapped buffer
4756 * If flush took the "buffer" see if we have one from before
4758 if (!b->buf && m->bbuf)
4761 PerlIOBuf_get_base(aTHX_ f);
4765 return PerlIOBuf_unread(aTHX_ f, vbuf, count);
4769 PerlIOMmap_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4771 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4772 PerlIOBuf * const b = &m->base;
4774 if (!b->buf || !(PerlIOBase(f)->flags & PERLIO_F_WRBUF)) {
4776 * No, or wrong sort of, buffer
4779 if (PerlIOMmap_unmap(aTHX_ f) != 0)
4783 * If unmap took the "buffer" see if we have one from before
4785 if (!b->buf && m->bbuf)
4788 PerlIOBuf_get_base(aTHX_ f);
4792 return PerlIOBuf_write(aTHX_ f, vbuf, count);
4796 PerlIOMmap_flush(pTHX_ PerlIO *f)
4798 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4799 PerlIOBuf * const b = &m->base;
4800 IV code = PerlIOBuf_flush(aTHX_ f);
4802 * Now we are "synced" at PerlIOBuf level
4809 if (PerlIOMmap_unmap(aTHX_ f) != 0)
4814 * We seem to have a PerlIOBuf buffer which was not mapped
4815 * remember it in case we need one later
4824 PerlIOMmap_fill(pTHX_ PerlIO *f)
4826 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4827 IV code = PerlIO_flush(f);
4828 if (code == 0 && !b->buf) {
4829 code = PerlIOMmap_map(aTHX_ f);
4831 if (code == 0 && !(PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4832 code = PerlIOBuf_fill(aTHX_ f);
4838 PerlIOMmap_close(pTHX_ PerlIO *f)
4840 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4841 PerlIOBuf * const b = &m->base;
4842 IV code = PerlIO_flush(f);
4846 b->ptr = b->end = b->buf;
4848 if (PerlIOBuf_close(aTHX_ f) != 0)
4854 PerlIOMmap_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
4856 return PerlIOBase_dup(aTHX_ f, o, param, flags);
4860 PERLIO_FUNCS_DECL(PerlIO_mmap) = {
4861 sizeof(PerlIO_funcs),
4864 PERLIO_K_BUFFERED|PERLIO_K_RAW,
4868 PerlIOBase_binmode, /* binmode */
4882 PerlIOBase_clearerr,
4883 PerlIOBase_setlinebuf,
4884 PerlIOMmap_get_base,
4888 PerlIOBuf_set_ptrcnt,
4891 #endif /* HAS_MMAP */
4894 Perl_PerlIO_stdin(pTHX)
4898 PerlIO_stdstreams(aTHX);
4900 return &PL_perlio[1];
4904 Perl_PerlIO_stdout(pTHX)
4908 PerlIO_stdstreams(aTHX);
4910 return &PL_perlio[2];
4914 Perl_PerlIO_stderr(pTHX)
4918 PerlIO_stdstreams(aTHX);
4920 return &PL_perlio[3];
4923 /*--------------------------------------------------------------------------------------*/
4926 PerlIO_getname(PerlIO *f, char *buf)
4931 bool exported = FALSE;
4932 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
4934 stdio = PerlIO_exportFILE(f,0);
4938 name = fgetname(stdio, buf);
4939 if (exported) PerlIO_releaseFILE(f,stdio);
4944 PERL_UNUSED_ARG(buf);
4945 Perl_croak(aTHX_ "Don't know how to get file name");
4951 /*--------------------------------------------------------------------------------------*/
4953 * Functions which can be called on any kind of PerlIO implemented in
4957 #undef PerlIO_fdopen
4959 PerlIO_fdopen(int fd, const char *mode)
4962 return PerlIO_openn(aTHX_ NULL, mode, fd, 0, 0, NULL, 0, NULL);
4967 PerlIO_open(const char *path, const char *mode)
4970 SV *name = sv_2mortal(newSVpv(path, 0));
4971 return PerlIO_openn(aTHX_ NULL, mode, -1, 0, 0, NULL, 1, &name);
4974 #undef Perlio_reopen
4976 PerlIO_reopen(const char *path, const char *mode, PerlIO *f)
4979 SV *name = sv_2mortal(newSVpv(path,0));
4980 return PerlIO_openn(aTHX_ NULL, mode, -1, 0, 0, f, 1, &name);
4985 PerlIO_getc(PerlIO *f)
4989 if ( 1 == PerlIO_read(f, buf, 1) ) {
4990 return (unsigned char) buf[0];
4995 #undef PerlIO_ungetc
4997 PerlIO_ungetc(PerlIO *f, int ch)
5002 if (PerlIO_unread(f, &buf, 1) == 1)
5010 PerlIO_putc(PerlIO *f, int ch)
5014 return PerlIO_write(f, &buf, 1);
5019 PerlIO_puts(PerlIO *f, const char *s)
5022 return PerlIO_write(f, s, strlen(s));
5025 #undef PerlIO_rewind
5027 PerlIO_rewind(PerlIO *f)
5030 PerlIO_seek(f, (Off_t) 0, SEEK_SET);
5034 #undef PerlIO_vprintf
5036 PerlIO_vprintf(PerlIO *f, const char *fmt, va_list ap)
5039 SV * const sv = newSVpvs("");
5045 Perl_va_copy(ap, apc);
5046 sv_vcatpvf(sv, fmt, &apc);
5048 sv_vcatpvf(sv, fmt, &ap);
5050 s = SvPV_const(sv, len);
5051 wrote = PerlIO_write(f, s, len);
5056 #undef PerlIO_printf
5058 PerlIO_printf(PerlIO *f, const char *fmt, ...)
5063 result = PerlIO_vprintf(f, fmt, ap);
5068 #undef PerlIO_stdoutf
5070 PerlIO_stdoutf(const char *fmt, ...)
5076 result = PerlIO_vprintf(PerlIO_stdout(), fmt, ap);
5081 #undef PerlIO_tmpfile
5083 PerlIO_tmpfile(void)
5088 const int fd = win32_tmpfd();
5090 f = PerlIO_fdopen(fd, "w+b");
5092 # if defined(HAS_MKSTEMP) && ! defined(VMS) && ! defined(OS2)
5093 SV * const sv = newSVpvs("/tmp/PerlIO_XXXXXX");
5095 * I have no idea how portable mkstemp() is ... NI-S
5097 const int fd = mkstemp(SvPVX(sv));
5099 f = PerlIO_fdopen(fd, "w+");
5101 PerlIOBase(f)->flags |= PERLIO_F_TEMP;
5102 PerlLIO_unlink(SvPVX_const(sv));
5105 # else /* !HAS_MKSTEMP, fallback to stdio tmpfile(). */
5106 FILE * const stdio = PerlSIO_tmpfile();
5109 f = PerlIO_fdopen(fileno(stdio), "w+");
5111 # endif /* else HAS_MKSTEMP */
5112 #endif /* else WIN32 */
5119 #endif /* USE_SFIO */
5120 #endif /* PERLIO_IS_STDIO */
5122 /*======================================================================================*/
5124 * Now some functions in terms of above which may be needed even if we are
5125 * not in true PerlIO mode
5128 Perl_PerlIO_context_layers(pTHX_ const char *mode)
5131 const char *direction = NULL;
5134 * Need to supply default layer info from open.pm
5140 if (mode && mode[0] != 'r') {
5141 if (PL_curcop->cop_hints & HINT_LEXICAL_IO_OUT)
5142 direction = "open>";
5144 if (PL_curcop->cop_hints & HINT_LEXICAL_IO_IN)
5145 direction = "open<";
5150 layers = Perl_refcounted_he_fetch(aTHX_ PL_curcop->cop_hints_hash,
5151 0, direction, 5, 0, 0);
5154 return SvOK(layers) ? SvPV_nolen_const(layers) : NULL;
5159 #undef PerlIO_setpos
5161 PerlIO_setpos(PerlIO *f, SV *pos)
5166 const Off_t * const posn = (Off_t *) SvPV(pos, len);
5167 if (f && len == sizeof(Off_t))
5168 return PerlIO_seek(f, *posn, SEEK_SET);
5170 SETERRNO(EINVAL, SS_IVCHAN);
5174 #undef PerlIO_setpos
5176 PerlIO_setpos(PerlIO *f, SV *pos)
5181 Fpos_t * const fpos = (Fpos_t *) SvPV(pos, len);
5182 if (f && len == sizeof(Fpos_t)) {
5183 #if defined(USE_64_BIT_STDIO) && defined(USE_FSETPOS64)
5184 return fsetpos64(f, fpos);
5186 return fsetpos(f, fpos);
5190 SETERRNO(EINVAL, SS_IVCHAN);
5196 #undef PerlIO_getpos
5198 PerlIO_getpos(PerlIO *f, SV *pos)
5201 Off_t posn = PerlIO_tell(f);
5202 sv_setpvn(pos, (char *) &posn, sizeof(posn));
5203 return (posn == (Off_t) - 1) ? -1 : 0;
5206 #undef PerlIO_getpos
5208 PerlIO_getpos(PerlIO *f, SV *pos)
5213 #if defined(USE_64_BIT_STDIO) && defined(USE_FSETPOS64)
5214 code = fgetpos64(f, &fpos);
5216 code = fgetpos(f, &fpos);
5218 sv_setpvn(pos, (char *) &fpos, sizeof(fpos));
5223 #if (defined(PERLIO_IS_STDIO) || !defined(USE_SFIO)) && !defined(HAS_VPRINTF)
5226 vprintf(char *pat, char *args)
5228 _doprnt(pat, args, stdout);
5229 return 0; /* wrong, but perl doesn't use the return
5234 vfprintf(FILE *fd, char *pat, char *args)
5236 _doprnt(pat, args, fd);
5237 return 0; /* wrong, but perl doesn't use the return
5243 #ifndef PerlIO_vsprintf
5245 PerlIO_vsprintf(char *s, int n, const char *fmt, va_list ap)
5248 const int val = my_vsnprintf(s, n > 0 ? n : 0, fmt, ap);
5249 PERL_UNUSED_CONTEXT;
5251 #ifndef PERL_MY_VSNPRINTF_GUARDED
5252 if (val < 0 || (n > 0 ? val >= n : 0)) {
5253 Perl_croak(aTHX_ "panic: my_vsnprintf overflow in PerlIO_vsprintf\n");
5260 #ifndef PerlIO_sprintf
5262 PerlIO_sprintf(char *s, int n, const char *fmt, ...)
5267 result = PerlIO_vsprintf(s, n, fmt, ap);
5275 * c-indentation-style: bsd
5277 * indent-tabs-mode: t
5280 * ex: set ts=8 sts=4 sw=4 noet: