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 = Perl_newSVpvf(aTHX_ "%s:%" IVdf " ", s ? s : "(none)",
511 (IV) CopLINE(PL_curcop));
512 Perl_sv_vcatpvf(aTHX_ sv, fmt, &ap);
514 s = SvPV_const(sv, len);
515 PerlLIO_write(PL_perlio_debug_fd, s, len);
522 /*--------------------------------------------------------------------------------------*/
525 * Inner level routines
529 * Table of pointers to the PerlIO structs (malloc'ed)
531 #define PERLIO_TABLE_SIZE 64
534 PerlIO_allocate(pTHX)
538 * Find a free slot in the table, allocating new table as necessary
543 while ((f = *last)) {
545 last = (PerlIO **) (f);
546 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
552 Newxz(f,PERLIO_TABLE_SIZE,PerlIO);
560 #undef PerlIO_fdupopen
562 PerlIO_fdupopen(pTHX_ PerlIO *f, CLONE_PARAMS *param, int flags)
564 if (PerlIOValid(f)) {
565 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;
566 PerlIO_debug("fdupopen f=%p param=%p\n",(void*)f,(void*)param);
568 return (*tab->Dup)(aTHX_ PerlIO_allocate(aTHX), f, param, flags);
570 return PerlIOBase_dup(aTHX_ PerlIO_allocate(aTHX), f, param, flags);
574 SETERRNO(EBADF, SS_IVCHAN);
580 PerlIO_cleantable(pTHX_ PerlIO **tablep)
582 PerlIO * const table = *tablep;
585 PerlIO_cleantable(aTHX_(PerlIO **) & (table[0]));
586 for (i = PERLIO_TABLE_SIZE - 1; i > 0; i--) {
587 PerlIO * const f = table + i;
599 PerlIO_list_alloc(pTHX)
603 Newxz(list, 1, PerlIO_list_t);
609 PerlIO_list_free(pTHX_ PerlIO_list_t *list)
612 if (--list->refcnt == 0) {
615 for (i = 0; i < list->cur; i++) {
616 if (list->array[i].arg)
617 SvREFCNT_dec(list->array[i].arg);
619 Safefree(list->array);
627 PerlIO_list_push(pTHX_ PerlIO_list_t *list, PerlIO_funcs *funcs, SV *arg)
633 if (list->cur >= list->len) {
636 Renew(list->array, list->len, PerlIO_pair_t);
638 Newx(list->array, list->len, PerlIO_pair_t);
640 p = &(list->array[list->cur++]);
642 if ((p->arg = arg)) {
643 SvREFCNT_inc_simple_void_NN(arg);
648 PerlIO_clone_list(pTHX_ PerlIO_list_t *proto, CLONE_PARAMS *param)
650 PerlIO_list_t *list = NULL;
653 list = PerlIO_list_alloc(aTHX);
654 for (i=0; i < proto->cur; i++) {
655 SV *arg = proto->array[i].arg;
658 arg = sv_dup(arg, param);
660 PERL_UNUSED_ARG(param);
662 PerlIO_list_push(aTHX_ list, proto->array[i].funcs, arg);
669 PerlIO_clone(pTHX_ PerlInterpreter *proto, CLONE_PARAMS *param)
672 PerlIO **table = &proto->Iperlio;
675 PL_known_layers = PerlIO_clone_list(aTHX_ proto->Iknown_layers, param);
676 PL_def_layerlist = PerlIO_clone_list(aTHX_ proto->Idef_layerlist, param);
677 PerlIO_allocate(aTHX); /* root slot is never used */
678 PerlIO_debug("Clone %p from %p\n",(void*)aTHX,(void*)proto);
679 while ((f = *table)) {
681 table = (PerlIO **) (f++);
682 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
684 (void) fp_dup(f, 0, param);
691 PERL_UNUSED_ARG(proto);
692 PERL_UNUSED_ARG(param);
697 PerlIO_destruct(pTHX)
700 PerlIO **table = &PL_perlio;
703 PerlIO_debug("Destruct %p\n",(void*)aTHX);
705 while ((f = *table)) {
707 table = (PerlIO **) (f++);
708 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
712 if (l->tab->kind & PERLIO_K_DESTRUCT) {
713 PerlIO_debug("Destruct popping %s\n", l->tab->name);
727 PerlIO_pop(pTHX_ PerlIO *f)
729 const PerlIOl *l = *f;
731 PerlIO_debug("PerlIO_pop f=%p %s\n", (void*)f, l->tab->name);
732 if (l->tab->Popped) {
734 * If popped returns non-zero do not free its layer structure
735 * it has either done so itself, or it is shared and still in
738 if ((*l->tab->Popped) (aTHX_ f) != 0)
746 /* Return as an array the stack of layers on a filehandle. Note that
747 * the stack is returned top-first in the array, and there are three
748 * times as many array elements as there are layers in the stack: the
749 * first element of a layer triplet is the name, the second one is the
750 * arguments, and the third one is the flags. */
753 PerlIO_get_layers(pTHX_ PerlIO *f)
756 AV * const av = newAV();
758 if (PerlIOValid(f)) {
759 PerlIOl *l = PerlIOBase(f);
762 SV * const name = l->tab && l->tab->name ?
763 newSVpv(l->tab->name, 0) : &PL_sv_undef;
764 SV * const arg = l->tab && l->tab->Getarg ?
765 (*l->tab->Getarg)(aTHX_ &l, 0, 0) : &PL_sv_undef;
768 av_push(av, newSViv((IV)l->flags));
776 /*--------------------------------------------------------------------------------------*/
778 * XS Interface for perl code
782 PerlIO_find_layer(pTHX_ const char *name, STRLEN len, int load)
786 if ((SSize_t) len <= 0)
788 for (i = 0; i < PL_known_layers->cur; i++) {
789 PerlIO_funcs * const f = PL_known_layers->array[i].funcs;
790 if (memEQ(f->name, name, len) && f->name[len] == 0) {
791 PerlIO_debug("%.*s => %p\n", (int) len, name, (void*)f);
795 if (load && PL_subname && PL_def_layerlist
796 && PL_def_layerlist->cur >= 2) {
797 if (PL_in_load_module) {
798 Perl_croak(aTHX_ "Recursive call to Perl_load_module in PerlIO_find_layer");
801 SV * const pkgsv = newSVpvs("PerlIO");
802 SV * const layer = newSVpvn(name, len);
803 CV * const cv = Perl_get_cvn_flags(aTHX_ STR_WITH_LEN("PerlIO::Layer::NoWarnings"), 0);
805 SAVEINT(PL_in_load_module);
807 SAVEGENERICSV(PL_warnhook);
808 PL_warnhook = (SV *) (SvREFCNT_inc_simple_NN(cv));
812 * The two SVs are magically freed by load_module
814 Perl_load_module(aTHX_ 0, pkgsv, NULL, layer, NULL);
817 return PerlIO_find_layer(aTHX_ name, len, 0);
820 PerlIO_debug("Cannot find %.*s\n", (int) len, name);
824 #ifdef USE_ATTRIBUTES_FOR_PERLIO
827 perlio_mg_set(pTHX_ SV *sv, MAGIC *mg)
830 IO * const io = GvIOn((GV *) SvRV(sv));
831 PerlIO * const ifp = IoIFP(io);
832 PerlIO * const ofp = IoOFP(io);
833 Perl_warn(aTHX_ "set %" SVf " %p %p %p",
834 SVfARG(sv), (void*)io, (void*)ifp, (void*)ofp);
840 perlio_mg_get(pTHX_ SV *sv, MAGIC *mg)
843 IO * const io = GvIOn((GV *) SvRV(sv));
844 PerlIO * const ifp = IoIFP(io);
845 PerlIO * const ofp = IoOFP(io);
846 Perl_warn(aTHX_ "get %" SVf " %p %p %p",
847 SVfARG(sv), (void*)io, (void*)ifp, (void*)ofp);
853 perlio_mg_clear(pTHX_ SV *sv, MAGIC *mg)
855 Perl_warn(aTHX_ "clear %" SVf, SVfARG(sv));
860 perlio_mg_free(pTHX_ SV *sv, MAGIC *mg)
862 Perl_warn(aTHX_ "free %" SVf, SVfARG(sv));
866 MGVTBL perlio_vtab = {
874 XS(XS_io_MODIFY_SCALAR_ATTRIBUTES)
877 SV * const sv = SvRV(ST(1));
878 AV * const av = newAV();
882 sv_magic(sv, (SV *) av, PERL_MAGIC_ext, NULL, 0);
884 mg = mg_find(sv, PERL_MAGIC_ext);
885 mg->mg_virtual = &perlio_vtab;
887 Perl_warn(aTHX_ "attrib %" SVf, SVfARG(sv));
888 for (i = 2; i < items; i++) {
890 const char * const name = SvPV_const(ST(i), len);
891 SV * const layer = PerlIO_find_layer(aTHX_ name, len, 1);
893 av_push(av, SvREFCNT_inc_simple_NN(layer));
904 #endif /* USE_ATTIBUTES_FOR_PERLIO */
907 PerlIO_tab_sv(pTHX_ PerlIO_funcs *tab)
909 HV * const stash = gv_stashpvs("PerlIO::Layer", GV_ADD);
910 SV * const sv = sv_bless(newRV_noinc(newSViv(PTR2IV(tab))), stash);
914 XS(XS_PerlIO__Layer__NoWarnings)
916 /* This is used as a %SIG{__WARN__} handler to supress warnings
917 during loading of layers.
923 PerlIO_debug("warning:%s\n",SvPV_nolen_const(ST(0)));
927 XS(XS_PerlIO__Layer__find)
933 Perl_croak(aTHX_ "Usage class->find(name[,load])");
936 const char * const name = SvPV_const(ST(1), len);
937 const bool load = (items > 2) ? SvTRUE(ST(2)) : 0;
938 PerlIO_funcs * const layer = PerlIO_find_layer(aTHX_ name, len, load);
940 (layer) ? sv_2mortal(PerlIO_tab_sv(aTHX_ layer)) :
947 PerlIO_define_layer(pTHX_ PerlIO_funcs *tab)
950 if (!PL_known_layers)
951 PL_known_layers = PerlIO_list_alloc(aTHX);
952 PerlIO_list_push(aTHX_ PL_known_layers, tab, NULL);
953 PerlIO_debug("define %s %p\n", tab->name, (void*)tab);
957 PerlIO_parse_layers(pTHX_ PerlIO_list_t *av, const char *names)
961 const char *s = names;
963 while (isSPACE(*s) || *s == ':')
968 const char *as = NULL;
970 if (!isIDFIRST(*s)) {
972 * Message is consistent with how attribute lists are
973 * passed. Even though this means "foo : : bar" is
974 * seen as an invalid separator character.
976 const char q = ((*s == '\'') ? '"' : '\'');
977 if (ckWARN(WARN_LAYER))
978 Perl_warner(aTHX_ packWARN(WARN_LAYER),
979 "Invalid separator character %c%c%c in PerlIO layer specification %s",
981 SETERRNO(EINVAL, LIB_INVARG);
986 } while (isALNUM(*e));
1002 * It's a nul terminated string, not allowed
1003 * to \ the terminating null. Anything other
1004 * character is passed over.
1014 if (ckWARN(WARN_LAYER))
1015 Perl_warner(aTHX_ packWARN(WARN_LAYER),
1016 "Argument list not closed for PerlIO layer \"%.*s\"",
1028 PerlIO_funcs * const layer =
1029 PerlIO_find_layer(aTHX_ s, llen, 1);
1033 arg = newSVpvn(as, alen);
1034 PerlIO_list_push(aTHX_ av, layer,
1035 (arg) ? arg : &PL_sv_undef);
1040 if (ckWARN(WARN_LAYER))
1041 Perl_warner(aTHX_ packWARN(WARN_LAYER), "Unknown PerlIO layer \"%.*s\"",
1054 PerlIO_default_buffer(pTHX_ PerlIO_list_t *av)
1057 PERLIO_FUNCS_DECL(*tab) = &PerlIO_perlio;
1058 #ifdef PERLIO_USING_CRLF
1061 if (PerlIO_stdio.Set_ptrcnt)
1062 tab = &PerlIO_stdio;
1064 PerlIO_debug("Pushing %s\n", tab->name);
1065 PerlIO_list_push(aTHX_ av, PerlIO_find_layer(aTHX_ tab->name, 0, 0),
1070 PerlIO_arg_fetch(PerlIO_list_t *av, IV n)
1072 return av->array[n].arg;
1076 PerlIO_layer_fetch(pTHX_ PerlIO_list_t *av, IV n, PerlIO_funcs *def)
1078 if (n >= 0 && n < av->cur) {
1079 PerlIO_debug("Layer %" IVdf " is %s\n", n,
1080 av->array[n].funcs->name);
1081 return av->array[n].funcs;
1084 Perl_croak(aTHX_ "panic: PerlIO layer array corrupt");
1089 PerlIOPop_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1091 PERL_UNUSED_ARG(mode);
1092 PERL_UNUSED_ARG(arg);
1093 PERL_UNUSED_ARG(tab);
1094 if (PerlIOValid(f)) {
1096 PerlIO_pop(aTHX_ f);
1102 PERLIO_FUNCS_DECL(PerlIO_remove) = {
1103 sizeof(PerlIO_funcs),
1106 PERLIO_K_DUMMY | PERLIO_K_UTF8,
1126 NULL, /* get_base */
1127 NULL, /* get_bufsiz */
1130 NULL, /* set_ptrcnt */
1134 PerlIO_default_layers(pTHX)
1137 if (!PL_def_layerlist) {
1138 const char * const s = (PL_tainting) ? NULL : PerlEnv_getenv("PERLIO");
1139 PERLIO_FUNCS_DECL(*osLayer) = &PerlIO_unix;
1140 PL_def_layerlist = PerlIO_list_alloc(aTHX);
1141 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_unix));
1143 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_win32));
1145 osLayer = &PerlIO_win32;
1148 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_raw));
1149 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_perlio));
1150 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_stdio));
1151 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_crlf));
1153 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_mmap));
1155 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_utf8));
1156 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_remove));
1157 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_byte));
1158 PerlIO_list_push(aTHX_ PL_def_layerlist,
1159 PerlIO_find_layer(aTHX_ osLayer->name, 0, 0),
1162 PerlIO_parse_layers(aTHX_ PL_def_layerlist, s);
1165 PerlIO_default_buffer(aTHX_ PL_def_layerlist);
1168 if (PL_def_layerlist->cur < 2) {
1169 PerlIO_default_buffer(aTHX_ PL_def_layerlist);
1171 return PL_def_layerlist;
1175 Perl_boot_core_PerlIO(pTHX)
1177 #ifdef USE_ATTRIBUTES_FOR_PERLIO
1178 newXS("io::MODIFY_SCALAR_ATTRIBUTES", XS_io_MODIFY_SCALAR_ATTRIBUTES,
1181 newXS("PerlIO::Layer::find", XS_PerlIO__Layer__find, __FILE__);
1182 newXS("PerlIO::Layer::NoWarnings", XS_PerlIO__Layer__NoWarnings, __FILE__);
1186 PerlIO_default_layer(pTHX_ I32 n)
1189 PerlIO_list_t * const av = PerlIO_default_layers(aTHX);
1192 return PerlIO_layer_fetch(aTHX_ av, n, PERLIO_FUNCS_CAST(&PerlIO_stdio));
1195 #define PerlIO_default_top() PerlIO_default_layer(aTHX_ -1)
1196 #define PerlIO_default_btm() PerlIO_default_layer(aTHX_ 0)
1199 PerlIO_stdstreams(pTHX)
1203 PerlIO_allocate(aTHX);
1204 PerlIO_fdopen(0, "Ir" PERLIO_STDTEXT);
1205 PerlIO_fdopen(1, "Iw" PERLIO_STDTEXT);
1206 PerlIO_fdopen(2, "Iw" PERLIO_STDTEXT);
1211 PerlIO_push(pTHX_ PerlIO *f, PERLIO_FUNCS_DECL(*tab), const char *mode, SV *arg)
1213 if (tab->fsize != sizeof(PerlIO_funcs)) {
1215 Perl_croak(aTHX_ "Layer does not match this perl");
1219 if (tab->size < sizeof(PerlIOl)) {
1222 /* Real layer with a data area */
1225 Newxz(temp, tab->size, char);
1229 l->tab = (PerlIO_funcs*) tab;
1231 PerlIO_debug("PerlIO_push f=%p %s %s %p\n",
1232 (void*)f, tab->name,
1233 (mode) ? mode : "(Null)", (void*)arg);
1234 if (*l->tab->Pushed &&
1236 (aTHX_ f, mode, arg, (PerlIO_funcs*) tab) != 0) {
1237 PerlIO_pop(aTHX_ f);
1246 /* Pseudo-layer where push does its own stack adjust */
1247 PerlIO_debug("PerlIO_push f=%p %s %s %p\n", (void*)f, tab->name,
1248 (mode) ? mode : "(Null)", (void*)arg);
1250 (*tab->Pushed) (aTHX_ f, mode, arg, (PerlIO_funcs*) tab) != 0) {
1258 PerlIOBase_binmode(pTHX_ PerlIO *f)
1260 if (PerlIOValid(f)) {
1261 /* Is layer suitable for raw stream ? */
1262 if (PerlIOBase(f)->tab->kind & PERLIO_K_RAW) {
1263 /* Yes - turn off UTF-8-ness, to undo UTF-8 locale effects */
1264 PerlIOBase(f)->flags &= ~PERLIO_F_UTF8;
1267 /* Not suitable - pop it */
1268 PerlIO_pop(aTHX_ f);
1276 PerlIORaw_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1278 PERL_UNUSED_ARG(mode);
1279 PERL_UNUSED_ARG(arg);
1280 PERL_UNUSED_ARG(tab);
1282 if (PerlIOValid(f)) {
1287 * Strip all layers that are not suitable for a raw stream
1290 while (t && (l = *t)) {
1291 if (l->tab->Binmode) {
1292 /* Has a handler - normal case */
1293 if ((*l->tab->Binmode)(aTHX_ f) == 0) {
1295 /* Layer still there - move down a layer */
1304 /* No handler - pop it */
1305 PerlIO_pop(aTHX_ t);
1308 if (PerlIOValid(f)) {
1309 PerlIO_debug(":raw f=%p :%s\n", (void*)f, PerlIOBase(f)->tab->name);
1317 PerlIO_apply_layera(pTHX_ PerlIO *f, const char *mode,
1318 PerlIO_list_t *layers, IV n, IV max)
1322 PerlIO_funcs * const tab = PerlIO_layer_fetch(aTHX_ layers, n, NULL);
1324 if (!PerlIO_push(aTHX_ f, tab, mode, PerlIOArg)) {
1335 PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode, const char *names)
1339 PerlIO_list_t * const layers = PerlIO_list_alloc(aTHX);
1340 code = PerlIO_parse_layers(aTHX_ layers, names);
1342 code = PerlIO_apply_layera(aTHX_ f, mode, layers, 0, layers->cur);
1344 PerlIO_list_free(aTHX_ layers);
1350 /*--------------------------------------------------------------------------------------*/
1352 * Given the abstraction above the public API functions
1356 PerlIO_binmode(pTHX_ PerlIO *f, int iotype, int mode, const char *names)
1358 PerlIO_debug("PerlIO_binmode f=%p %s %c %x %s\n", (void*)f,
1359 (PerlIOBase(f)) ? PerlIOBase(f)->tab->name : "(Null)",
1360 iotype, mode, (names) ? names : "(Null)");
1363 /* Do not flush etc. if (e.g.) switching encodings.
1364 if a pushed layer knows it needs to flush lower layers
1365 (for example :unix which is never going to call them)
1366 it can do the flush when it is pushed.
1368 return PerlIO_apply_layers(aTHX_ f, NULL, names) == 0 ? TRUE : FALSE;
1371 /* Fake 5.6 legacy of using this call to turn ON O_TEXT */
1372 #ifdef PERLIO_USING_CRLF
1373 /* Legacy binmode only has meaning if O_TEXT has a value distinct from
1374 O_BINARY so we can look for it in mode.
1376 if (!(mode & O_BINARY)) {
1378 /* FIXME?: Looking down the layer stack seems wrong,
1379 but is a way of reaching past (say) an encoding layer
1380 to flip CRLF-ness of the layer(s) below
1383 /* Perhaps we should turn on bottom-most aware layer
1384 e.g. Ilya's idea that UNIX TTY could serve
1386 if (PerlIOBase(f)->tab->kind & PERLIO_K_CANCRLF) {
1387 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF)) {
1388 /* Not in text mode - flush any pending stuff and flip it */
1390 PerlIOBase(f)->flags |= PERLIO_F_CRLF;
1392 /* Only need to turn it on in one layer so we are done */
1397 /* Not finding a CRLF aware layer presumably means we are binary
1398 which is not what was requested - so we failed
1399 We _could_ push :crlf layer but so could caller
1404 /* Legacy binmode is now _defined_ as being equivalent to pushing :raw
1405 So code that used to be here is now in PerlIORaw_pushed().
1407 return PerlIO_push(aTHX_ f, PERLIO_FUNCS_CAST(&PerlIO_raw), NULL, NULL) ? TRUE : FALSE;
1412 PerlIO__close(pTHX_ PerlIO *f)
1414 if (PerlIOValid(f)) {
1415 PerlIO_funcs * const tab = PerlIOBase(f)->tab;
1416 if (tab && tab->Close)
1417 return (*tab->Close)(aTHX_ f);
1419 return PerlIOBase_close(aTHX_ f);
1422 SETERRNO(EBADF, SS_IVCHAN);
1428 Perl_PerlIO_close(pTHX_ PerlIO *f)
1430 const int code = PerlIO__close(aTHX_ f);
1431 while (PerlIOValid(f)) {
1432 PerlIO_pop(aTHX_ f);
1438 Perl_PerlIO_fileno(pTHX_ PerlIO *f)
1441 Perl_PerlIO_or_Base(f, Fileno, fileno, -1, (aTHX_ f));
1445 static PerlIO_funcs *
1446 PerlIO_layer_from_ref(pTHX_ SV *sv)
1450 * For any scalar type load the handler which is bundled with perl
1452 if (SvTYPE(sv) < SVt_PVAV) {
1453 PerlIO_funcs *f = PerlIO_find_layer(aTHX_ STR_WITH_LEN("scalar"), 1);
1454 /* This isn't supposed to happen, since PerlIO::scalar is core,
1455 * but could happen anyway in smaller installs or with PAR */
1456 if (!f && ckWARN(WARN_LAYER))
1457 Perl_warner(aTHX_ packWARN(WARN_LAYER), "Unknown PerlIO layer \"scalar\"");
1462 * For other types allow if layer is known but don't try and load it
1464 switch (SvTYPE(sv)) {
1466 return PerlIO_find_layer(aTHX_ STR_WITH_LEN("Array"), 0);
1468 return PerlIO_find_layer(aTHX_ STR_WITH_LEN("Hash"), 0);
1470 return PerlIO_find_layer(aTHX_ STR_WITH_LEN("Code"), 0);
1472 return PerlIO_find_layer(aTHX_ STR_WITH_LEN("Glob"), 0);
1479 PerlIO_resolve_layers(pTHX_ const char *layers,
1480 const char *mode, int narg, SV **args)
1483 PerlIO_list_t *def = PerlIO_default_layers(aTHX);
1486 PerlIO_stdstreams(aTHX);
1488 SV * const arg = *args;
1490 * If it is a reference but not an object see if we have a handler
1493 if (SvROK(arg) && !sv_isobject(arg)) {
1494 PerlIO_funcs * const handler = PerlIO_layer_from_ref(aTHX_ SvRV(arg));
1496 def = PerlIO_list_alloc(aTHX);
1497 PerlIO_list_push(aTHX_ def, handler, &PL_sv_undef);
1501 * Don't fail if handler cannot be found :via(...) etc. may do
1502 * something sensible else we will just stringfy and open
1507 if (!layers || !*layers)
1508 layers = Perl_PerlIO_context_layers(aTHX_ mode);
1509 if (layers && *layers) {
1512 av = PerlIO_clone_list(aTHX_ def, NULL);
1517 if (PerlIO_parse_layers(aTHX_ av, layers) == 0) {
1521 PerlIO_list_free(aTHX_ av);
1533 PerlIO_openn(pTHX_ const char *layers, const char *mode, int fd,
1534 int imode, int perm, PerlIO *f, int narg, SV **args)
1537 if (!f && narg == 1 && *args == &PL_sv_undef) {
1538 if ((f = PerlIO_tmpfile())) {
1539 if (!layers || !*layers)
1540 layers = Perl_PerlIO_context_layers(aTHX_ mode);
1541 if (layers && *layers)
1542 PerlIO_apply_layers(aTHX_ f, mode, layers);
1546 PerlIO_list_t *layera;
1548 PerlIO_funcs *tab = NULL;
1549 if (PerlIOValid(f)) {
1551 * This is "reopen" - it is not tested as perl does not use it
1555 layera = PerlIO_list_alloc(aTHX);
1559 arg = (*l->tab->Getarg) (aTHX_ &l, NULL, 0);
1560 PerlIO_list_push(aTHX_ layera, l->tab,
1561 (arg) ? arg : &PL_sv_undef);
1564 l = *PerlIONext(&l);
1568 layera = PerlIO_resolve_layers(aTHX_ layers, mode, narg, args);
1574 * Start at "top" of layer stack
1576 n = layera->cur - 1;
1578 PerlIO_funcs * const t = PerlIO_layer_fetch(aTHX_ layera, n, NULL);
1587 * Found that layer 'n' can do opens - call it
1589 if (narg > 1 && !(tab->kind & PERLIO_K_MULTIARG)) {
1590 Perl_croak(aTHX_ "More than one argument to open(,':%s')",tab->name);
1592 PerlIO_debug("openn(%s,'%s','%s',%d,%x,%o,%p,%d,%p)\n",
1593 tab->name, layers ? layers : "(Null)", mode, fd,
1594 imode, perm, (void*)f, narg, (void*)args);
1596 f = (*tab->Open) (aTHX_ tab, layera, n, mode, fd, imode, perm,
1599 SETERRNO(EINVAL, LIB_INVARG);
1603 if (n + 1 < layera->cur) {
1605 * More layers above the one that we used to open -
1608 if (PerlIO_apply_layera(aTHX_ f, mode, layera, n + 1, layera->cur) != 0) {
1609 /* If pushing layers fails close the file */
1616 PerlIO_list_free(aTHX_ layera);
1623 Perl_PerlIO_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
1625 Perl_PerlIO_or_Base(f, Read, read, -1, (aTHX_ f, vbuf, count));
1629 Perl_PerlIO_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
1631 Perl_PerlIO_or_Base(f, Unread, unread, -1, (aTHX_ f, vbuf, count));
1635 Perl_PerlIO_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
1637 Perl_PerlIO_or_fail(f, Write, -1, (aTHX_ f, vbuf, count));
1641 Perl_PerlIO_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
1643 Perl_PerlIO_or_fail(f, Seek, -1, (aTHX_ f, offset, whence));
1647 Perl_PerlIO_tell(pTHX_ PerlIO *f)
1649 Perl_PerlIO_or_fail(f, Tell, -1, (aTHX_ f));
1653 Perl_PerlIO_flush(pTHX_ PerlIO *f)
1658 const PerlIO_funcs *tab = PerlIOBase(f)->tab;
1660 if (tab && tab->Flush)
1661 return (*tab->Flush) (aTHX_ f);
1663 return 0; /* If no Flush defined, silently succeed. */
1666 PerlIO_debug("Cannot flush f=%p\n", (void*)f);
1667 SETERRNO(EBADF, SS_IVCHAN);
1673 * Is it good API design to do flush-all on NULL, a potentially
1674 * errorneous input? Maybe some magical value (PerlIO*
1675 * PERLIO_FLUSH_ALL = (PerlIO*)-1;)? Yes, stdio does similar
1676 * things on fflush(NULL), but should we be bound by their design
1679 PerlIO **table = &PL_perlio;
1681 while ((f = *table)) {
1683 table = (PerlIO **) (f++);
1684 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
1685 if (*f && PerlIO_flush(f) != 0)
1695 PerlIOBase_flush_linebuf(pTHX)
1698 PerlIO **table = &PL_perlio;
1700 while ((f = *table)) {
1702 table = (PerlIO **) (f++);
1703 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
1706 flags & (PERLIO_F_LINEBUF | PERLIO_F_CANWRITE))
1707 == (PERLIO_F_LINEBUF | PERLIO_F_CANWRITE))
1715 Perl_PerlIO_fill(pTHX_ PerlIO *f)
1717 Perl_PerlIO_or_fail(f, Fill, -1, (aTHX_ f));
1721 PerlIO_isutf8(PerlIO *f)
1724 return (PerlIOBase(f)->flags & PERLIO_F_UTF8) != 0;
1726 SETERRNO(EBADF, SS_IVCHAN);
1732 Perl_PerlIO_eof(pTHX_ PerlIO *f)
1734 Perl_PerlIO_or_Base(f, Eof, eof, -1, (aTHX_ f));
1738 Perl_PerlIO_error(pTHX_ PerlIO *f)
1740 Perl_PerlIO_or_Base(f, Error, error, -1, (aTHX_ f));
1744 Perl_PerlIO_clearerr(pTHX_ PerlIO *f)
1746 Perl_PerlIO_or_Base_void(f, Clearerr, clearerr, (aTHX_ f));
1750 Perl_PerlIO_setlinebuf(pTHX_ PerlIO *f)
1752 Perl_PerlIO_or_Base_void(f, Setlinebuf, setlinebuf, (aTHX_ f));
1756 PerlIO_has_base(PerlIO *f)
1758 if (PerlIOValid(f)) {
1759 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;
1762 return (tab->Get_base != NULL);
1763 SETERRNO(EINVAL, LIB_INVARG);
1766 SETERRNO(EBADF, SS_IVCHAN);
1772 PerlIO_fast_gets(PerlIO *f)
1774 if (PerlIOValid(f) && (PerlIOBase(f)->flags & PERLIO_F_FASTGETS)) {
1775 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;
1778 return (tab->Set_ptrcnt != NULL);
1779 SETERRNO(EINVAL, LIB_INVARG);
1782 SETERRNO(EBADF, SS_IVCHAN);
1788 PerlIO_has_cntptr(PerlIO *f)
1790 if (PerlIOValid(f)) {
1791 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;
1794 return (tab->Get_ptr != NULL && tab->Get_cnt != NULL);
1795 SETERRNO(EINVAL, LIB_INVARG);
1798 SETERRNO(EBADF, SS_IVCHAN);
1804 PerlIO_canset_cnt(PerlIO *f)
1806 if (PerlIOValid(f)) {
1807 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;
1810 return (tab->Set_ptrcnt != NULL);
1811 SETERRNO(EINVAL, LIB_INVARG);
1814 SETERRNO(EBADF, SS_IVCHAN);
1820 Perl_PerlIO_get_base(pTHX_ PerlIO *f)
1822 Perl_PerlIO_or_fail(f, Get_base, NULL, (aTHX_ f));
1826 Perl_PerlIO_get_bufsiz(pTHX_ PerlIO *f)
1828 Perl_PerlIO_or_fail(f, Get_bufsiz, -1, (aTHX_ f));
1832 Perl_PerlIO_get_ptr(pTHX_ PerlIO *f)
1834 Perl_PerlIO_or_fail(f, Get_ptr, NULL, (aTHX_ f));
1838 Perl_PerlIO_get_cnt(pTHX_ PerlIO *f)
1840 Perl_PerlIO_or_fail(f, Get_cnt, -1, (aTHX_ f));
1844 Perl_PerlIO_set_cnt(pTHX_ PerlIO *f, int cnt)
1846 Perl_PerlIO_or_fail_void(f, Set_ptrcnt, (aTHX_ f, NULL, cnt));
1850 Perl_PerlIO_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, int cnt)
1852 Perl_PerlIO_or_fail_void(f, Set_ptrcnt, (aTHX_ f, ptr, cnt));
1856 /*--------------------------------------------------------------------------------------*/
1858 * utf8 and raw dummy layers
1862 PerlIOUtf8_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1864 PERL_UNUSED_CONTEXT;
1865 PERL_UNUSED_ARG(mode);
1866 PERL_UNUSED_ARG(arg);
1867 if (PerlIOValid(f)) {
1868 if (tab->kind & PERLIO_K_UTF8)
1869 PerlIOBase(f)->flags |= PERLIO_F_UTF8;
1871 PerlIOBase(f)->flags &= ~PERLIO_F_UTF8;
1877 PERLIO_FUNCS_DECL(PerlIO_utf8) = {
1878 sizeof(PerlIO_funcs),
1881 PERLIO_K_DUMMY | PERLIO_K_UTF8,
1901 NULL, /* get_base */
1902 NULL, /* get_bufsiz */
1905 NULL, /* set_ptrcnt */
1908 PERLIO_FUNCS_DECL(PerlIO_byte) = {
1909 sizeof(PerlIO_funcs),
1932 NULL, /* get_base */
1933 NULL, /* get_bufsiz */
1936 NULL, /* set_ptrcnt */
1940 PerlIORaw_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
1941 IV n, const char *mode, int fd, int imode, int perm,
1942 PerlIO *old, int narg, SV **args)
1944 PerlIO_funcs * const tab = PerlIO_default_btm();
1945 PERL_UNUSED_ARG(self);
1946 if (tab && tab->Open)
1947 return (*tab->Open) (aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
1949 SETERRNO(EINVAL, LIB_INVARG);
1953 PERLIO_FUNCS_DECL(PerlIO_raw) = {
1954 sizeof(PerlIO_funcs),
1977 NULL, /* get_base */
1978 NULL, /* get_bufsiz */
1981 NULL, /* set_ptrcnt */
1983 /*--------------------------------------------------------------------------------------*/
1984 /*--------------------------------------------------------------------------------------*/
1986 * "Methods" of the "base class"
1990 PerlIOBase_fileno(pTHX_ PerlIO *f)
1992 return PerlIOValid(f) ? PerlIO_fileno(PerlIONext(f)) : -1;
1996 PerlIO_modestr(PerlIO * f, char *buf)
1999 if (PerlIOValid(f)) {
2000 const IV flags = PerlIOBase(f)->flags;
2001 if (flags & PERLIO_F_APPEND) {
2003 if (flags & PERLIO_F_CANREAD) {
2007 else if (flags & PERLIO_F_CANREAD) {
2009 if (flags & PERLIO_F_CANWRITE)
2012 else if (flags & PERLIO_F_CANWRITE) {
2014 if (flags & PERLIO_F_CANREAD) {
2018 #ifdef PERLIO_USING_CRLF
2019 if (!(flags & PERLIO_F_CRLF))
2029 PerlIOBase_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2031 PerlIOl * const l = PerlIOBase(f);
2032 PERL_UNUSED_CONTEXT;
2033 PERL_UNUSED_ARG(arg);
2035 l->flags &= ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE |
2036 PERLIO_F_TRUNCATE | PERLIO_F_APPEND);
2037 if (tab->Set_ptrcnt != NULL)
2038 l->flags |= PERLIO_F_FASTGETS;
2040 if (*mode == IoTYPE_NUMERIC || *mode == IoTYPE_IMPLICIT)
2044 l->flags |= PERLIO_F_CANREAD;
2047 l->flags |= PERLIO_F_APPEND | PERLIO_F_CANWRITE;
2050 l->flags |= PERLIO_F_TRUNCATE | PERLIO_F_CANWRITE;
2053 SETERRNO(EINVAL, LIB_INVARG);
2059 l->flags |= PERLIO_F_CANREAD | PERLIO_F_CANWRITE;
2062 l->flags &= ~PERLIO_F_CRLF;
2065 l->flags |= PERLIO_F_CRLF;
2068 SETERRNO(EINVAL, LIB_INVARG);
2075 l->flags |= l->next->flags &
2076 (PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_TRUNCATE |
2081 PerlIO_debug("PerlIOBase_pushed f=%p %s %s fl=%08" UVxf " (%s)\n",
2082 (void*)f, PerlIOBase(f)->tab->name, (omode) ? omode : "(Null)",
2083 l->flags, PerlIO_modestr(f, temp));
2089 PerlIOBase_popped(pTHX_ PerlIO *f)
2091 PERL_UNUSED_CONTEXT;
2097 PerlIOBase_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
2100 * Save the position as current head considers it
2102 const Off_t old = PerlIO_tell(f);
2103 PerlIO_push(aTHX_ f, PERLIO_FUNCS_CAST(&PerlIO_pending), "r", NULL);
2104 PerlIOSelf(f, PerlIOBuf)->posn = old;
2105 return PerlIOBuf_unread(aTHX_ f, vbuf, count);
2109 PerlIOBase_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
2111 STDCHAR *buf = (STDCHAR *) vbuf;
2113 if (!(PerlIOBase(f)->flags & PERLIO_F_CANREAD)) {
2114 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2115 SETERRNO(EBADF, SS_IVCHAN);
2121 SSize_t avail = PerlIO_get_cnt(f);
2124 take = ((SSize_t)count < avail) ? (SSize_t)count : avail;
2126 STDCHAR *ptr = PerlIO_get_ptr(f);
2127 Copy(ptr, buf, take, STDCHAR);
2128 PerlIO_set_ptrcnt(f, ptr + take, (avail -= take));
2131 if (avail == 0) /* set_ptrcnt could have reset avail */
2134 if (count > 0 && avail <= 0) {
2135 if (PerlIO_fill(f) != 0)
2140 return (buf - (STDCHAR *) vbuf);
2146 PerlIOBase_noop_ok(pTHX_ PerlIO *f)
2148 PERL_UNUSED_CONTEXT;
2154 PerlIOBase_noop_fail(pTHX_ PerlIO *f)
2156 PERL_UNUSED_CONTEXT;
2162 PerlIOBase_close(pTHX_ PerlIO *f)
2165 if (PerlIOValid(f)) {
2166 PerlIO *n = PerlIONext(f);
2167 code = PerlIO_flush(f);
2168 PerlIOBase(f)->flags &=
2169 ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_OPEN);
2170 while (PerlIOValid(n)) {
2171 const PerlIO_funcs * const tab = PerlIOBase(n)->tab;
2172 if (tab && tab->Close) {
2173 if ((*tab->Close)(aTHX_ n) != 0)
2178 PerlIOBase(n)->flags &=
2179 ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_OPEN);
2185 SETERRNO(EBADF, SS_IVCHAN);
2191 PerlIOBase_eof(pTHX_ PerlIO *f)
2193 PERL_UNUSED_CONTEXT;
2194 if (PerlIOValid(f)) {
2195 return (PerlIOBase(f)->flags & PERLIO_F_EOF) != 0;
2201 PerlIOBase_error(pTHX_ PerlIO *f)
2203 PERL_UNUSED_CONTEXT;
2204 if (PerlIOValid(f)) {
2205 return (PerlIOBase(f)->flags & PERLIO_F_ERROR) != 0;
2211 PerlIOBase_clearerr(pTHX_ PerlIO *f)
2213 if (PerlIOValid(f)) {
2214 PerlIO * const n = PerlIONext(f);
2215 PerlIOBase(f)->flags &= ~(PERLIO_F_ERROR | PERLIO_F_EOF);
2222 PerlIOBase_setlinebuf(pTHX_ PerlIO *f)
2224 PERL_UNUSED_CONTEXT;
2225 if (PerlIOValid(f)) {
2226 PerlIOBase(f)->flags |= PERLIO_F_LINEBUF;
2231 PerlIO_sv_dup(pTHX_ SV *arg, CLONE_PARAMS *param)
2237 arg = sv_dup(arg, param);
2238 SvREFCNT_inc_simple_void_NN(arg);
2242 return newSVsv(arg);
2245 PERL_UNUSED_ARG(param);
2246 return newSVsv(arg);
2251 PerlIOBase_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2253 PerlIO * const nexto = PerlIONext(o);
2254 if (PerlIOValid(nexto)) {
2255 const PerlIO_funcs * const tab = PerlIOBase(nexto)->tab;
2256 if (tab && tab->Dup)
2257 f = (*tab->Dup)(aTHX_ f, nexto, param, flags);
2259 f = PerlIOBase_dup(aTHX_ f, nexto, param, flags);
2262 PerlIO_funcs * const self = PerlIOBase(o)->tab;
2265 PerlIO_debug("PerlIOBase_dup %s f=%p o=%p param=%p\n",
2266 self->name, (void*)f, (void*)o, (void*)param);
2268 arg = (*self->Getarg)(aTHX_ o, param, flags);
2269 f = PerlIO_push(aTHX_ f, self, PerlIO_modestr(o,buf), arg);
2270 if (PerlIOBase(o)->flags & PERLIO_F_UTF8)
2271 PerlIOBase(f)->flags |= PERLIO_F_UTF8;
2278 /* PL_perlio_fd_refcnt[] is in intrpvar.h */
2280 /* Must be called with PL_perlio_mutex locked. */
2282 S_more_refcounted_fds(pTHX_ const int new_fd) {
2284 const int old_max = PL_perlio_fd_refcnt_size;
2285 const int new_max = 16 + (new_fd & ~15);
2288 PerlIO_debug("More fds - old=%d, need %d, new=%d\n",
2289 old_max, new_fd, new_max);
2291 if (new_fd < old_max) {
2295 assert (new_max > new_fd);
2297 /* Use plain realloc() since we need this memory to be really
2298 * global and visible to all the interpreters and/or threads. */
2299 new_array = (int*) realloc(PL_perlio_fd_refcnt, new_max * sizeof(int));
2303 MUTEX_UNLOCK(&PL_perlio_mutex);
2305 /* Can't use PerlIO to write as it allocates memory */
2306 PerlLIO_write(PerlIO_fileno(Perl_error_log),
2307 PL_no_mem, strlen(PL_no_mem));
2311 PL_perlio_fd_refcnt_size = new_max;
2312 PL_perlio_fd_refcnt = new_array;
2314 PerlIO_debug("Zeroing %p, %d\n",
2315 (void*)(new_array + old_max),
2318 Zero(new_array + old_max, new_max - old_max, int);
2325 /* MUTEX_INIT(&PL_perlio_mutex) is done in PERL_SYS_INIT3(). */
2326 PERL_UNUSED_CONTEXT;
2330 PerlIOUnix_refcnt_inc(int fd)
2337 MUTEX_LOCK(&PL_perlio_mutex);
2339 if (fd >= PL_perlio_fd_refcnt_size)
2340 S_more_refcounted_fds(aTHX_ fd);
2342 PL_perlio_fd_refcnt[fd]++;
2343 if (PL_perlio_fd_refcnt[fd] <= 0) {
2344 Perl_croak(aTHX_ "refcnt_inc: fd %d: %d <= 0\n",
2345 fd, PL_perlio_fd_refcnt[fd]);
2347 PerlIO_debug("refcnt_inc: fd %d refcnt=%d\n",
2348 fd, PL_perlio_fd_refcnt[fd]);
2351 MUTEX_UNLOCK(&PL_perlio_mutex);
2354 Perl_croak(aTHX_ "refcnt_inc: fd %d < 0\n", fd);
2359 PerlIOUnix_refcnt_dec(int fd)
2366 MUTEX_LOCK(&PL_perlio_mutex);
2368 if (fd >= PL_perlio_fd_refcnt_size) {
2369 Perl_croak(aTHX_ "refcnt_dec: fd %d >= refcnt_size %d\n",
2370 fd, PL_perlio_fd_refcnt_size);
2372 if (PL_perlio_fd_refcnt[fd] <= 0) {
2373 Perl_croak(aTHX_ "refcnt_dec: fd %d: %d <= 0\n",
2374 fd, PL_perlio_fd_refcnt[fd]);
2376 cnt = --PL_perlio_fd_refcnt[fd];
2377 PerlIO_debug("refcnt_dec: fd %d refcnt=%d\n", fd, cnt);
2379 MUTEX_UNLOCK(&PL_perlio_mutex);
2382 Perl_croak(aTHX_ "refcnt_dec: fd %d < 0\n", fd);
2388 PerlIO_cleanup(pTHX)
2393 PerlIO_debug("Cleanup layers for %p\n",(void*)aTHX);
2395 PerlIO_debug("Cleanup layers\n");
2398 /* Raise STDIN..STDERR refcount so we don't close them */
2399 for (i=0; i < 3; i++)
2400 PerlIOUnix_refcnt_inc(i);
2401 PerlIO_cleantable(aTHX_ &PL_perlio);
2402 /* Restore STDIN..STDERR refcount */
2403 for (i=0; i < 3; i++)
2404 PerlIOUnix_refcnt_dec(i);
2406 if (PL_known_layers) {
2407 PerlIO_list_free(aTHX_ PL_known_layers);
2408 PL_known_layers = NULL;
2410 if (PL_def_layerlist) {
2411 PerlIO_list_free(aTHX_ PL_def_layerlist);
2412 PL_def_layerlist = NULL;
2416 void PerlIO_teardown(pTHX) /* Call only from PERL_SYS_TERM(). */
2421 /* By now all filehandles should have been closed, so any
2422 * stray (non-STD-)filehandles indicate *possible* (PerlIO)
2425 for (i = 3; i < PL_perlio_fd_refcnt_size; i++) {
2426 if (PL_perlio_fd_refcnt[i])
2427 PerlIO_debug("PerlIO_cleanup: fd %d refcnt=%d\n",
2428 i, PL_perlio_fd_refcnt[i]);
2432 /* Not bothering with PL_perlio_mutex since by now
2433 * all the interpreters are gone. */
2434 if (PL_perlio_fd_refcnt_size /* Assuming initial size of zero. */
2435 && PL_perlio_fd_refcnt) {
2436 free(PL_perlio_fd_refcnt); /* To match realloc() in S_more_refcounted_fds(). */
2437 PL_perlio_fd_refcnt = NULL;
2438 PL_perlio_fd_refcnt_size = 0;
2442 /*--------------------------------------------------------------------------------------*/
2444 * Bottom-most level for UNIX-like case
2448 struct _PerlIO base; /* The generic part */
2449 int fd; /* UNIX like file descriptor */
2450 int oflags; /* open/fcntl flags */
2454 PerlIOUnix_oflags(const char *mode)
2457 if (*mode == IoTYPE_IMPLICIT || *mode == IoTYPE_NUMERIC)
2462 if (*++mode == '+') {
2469 oflags = O_CREAT | O_TRUNC;
2470 if (*++mode == '+') {
2479 oflags = O_CREAT | O_APPEND;
2480 if (*++mode == '+') {
2493 else if (*mode == 't') {
2495 oflags &= ~O_BINARY;
2499 * Always open in binary mode
2502 if (*mode || oflags == -1) {
2503 SETERRNO(EINVAL, LIB_INVARG);
2510 PerlIOUnix_fileno(pTHX_ PerlIO *f)
2512 PERL_UNUSED_CONTEXT;
2513 return PerlIOSelf(f, PerlIOUnix)->fd;
2517 PerlIOUnix_setfd(pTHX_ PerlIO *f, int fd, int imode)
2519 PerlIOUnix * const s = PerlIOSelf(f, PerlIOUnix);
2522 if (PerlLIO_fstat(fd, &st) == 0) {
2523 if (!S_ISREG(st.st_mode)) {
2524 PerlIO_debug("%d is not regular file\n",fd);
2525 PerlIOBase(f)->flags |= PERLIO_F_NOTREG;
2528 PerlIO_debug("%d _is_ a regular file\n",fd);
2534 PerlIOUnix_refcnt_inc(fd);
2535 PERL_UNUSED_CONTEXT;
2539 PerlIOUnix_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2541 IV code = PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
2542 if (*PerlIONext(f)) {
2543 /* We never call down so do any pending stuff now */
2544 PerlIO_flush(PerlIONext(f));
2546 * XXX could (or should) we retrieve the oflags from the open file
2547 * handle rather than believing the "mode" we are passed in? XXX
2548 * Should the value on NULL mode be 0 or -1?
2550 PerlIOUnix_setfd(aTHX_ f, PerlIO_fileno(PerlIONext(f)),
2551 mode ? PerlIOUnix_oflags(mode) : -1);
2553 PerlIOBase(f)->flags |= PERLIO_F_OPEN;
2559 PerlIOUnix_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
2561 const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2563 PERL_UNUSED_CONTEXT;
2564 if (PerlIOBase(f)->flags & PERLIO_F_NOTREG) {
2566 SETERRNO(ESPIPE, LIB_INVARG);
2568 SETERRNO(EINVAL, LIB_INVARG);
2572 new_loc = PerlLIO_lseek(fd, offset, whence);
2573 if (new_loc == (Off_t) - 1)
2575 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
2580 PerlIOUnix_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
2581 IV n, const char *mode, int fd, int imode,
2582 int perm, PerlIO *f, int narg, SV **args)
2584 if (PerlIOValid(f)) {
2585 if (PerlIOBase(f)->flags & PERLIO_F_OPEN)
2586 (*PerlIOBase(f)->tab->Close)(aTHX_ f);
2589 if (*mode == IoTYPE_NUMERIC)
2592 imode = PerlIOUnix_oflags(mode);
2596 const char *path = SvPV_nolen_const(*args);
2597 fd = PerlLIO_open3(path, imode, perm);
2601 if (*mode == IoTYPE_IMPLICIT)
2604 f = PerlIO_allocate(aTHX);
2606 if (!PerlIOValid(f)) {
2607 if (!(f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg))) {
2611 PerlIOUnix_setfd(aTHX_ f, fd, imode);
2612 PerlIOBase(f)->flags |= PERLIO_F_OPEN;
2613 if (*mode == IoTYPE_APPEND)
2614 PerlIOUnix_seek(aTHX_ f, 0, SEEK_END);
2621 * FIXME: pop layers ???
2629 PerlIOUnix_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2631 const PerlIOUnix * const os = PerlIOSelf(o, PerlIOUnix);
2633 if (flags & PERLIO_DUP_FD) {
2634 fd = PerlLIO_dup(fd);
2637 f = PerlIOBase_dup(aTHX_ f, o, param, flags);
2639 /* If all went well overwrite fd in dup'ed lay with the dup()'ed fd */
2640 PerlIOUnix_setfd(aTHX_ f, fd, os->oflags);
2649 PerlIOUnix_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
2652 const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2653 #ifdef PERLIO_STD_SPECIAL
2655 return PERLIO_STD_IN(fd, vbuf, count);
2657 if (!(PerlIOBase(f)->flags & PERLIO_F_CANREAD) ||
2658 PerlIOBase(f)->flags & (PERLIO_F_EOF|PERLIO_F_ERROR)) {
2662 const SSize_t len = PerlLIO_read(fd, vbuf, count);
2663 if (len >= 0 || errno != EINTR) {
2665 if (errno != EAGAIN) {
2666 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2669 else if (len == 0 && count != 0) {
2670 PerlIOBase(f)->flags |= PERLIO_F_EOF;
2681 PerlIOUnix_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
2684 const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2685 #ifdef PERLIO_STD_SPECIAL
2686 if (fd == 1 || fd == 2)
2687 return PERLIO_STD_OUT(fd, vbuf, count);
2690 const SSize_t len = PerlLIO_write(fd, vbuf, count);
2691 if (len >= 0 || errno != EINTR) {
2693 if (errno != EAGAIN) {
2694 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2705 PerlIOUnix_tell(pTHX_ PerlIO *f)
2707 PERL_UNUSED_CONTEXT;
2709 return PerlLIO_lseek(PerlIOSelf(f, PerlIOUnix)->fd, 0, SEEK_CUR);
2714 PerlIOUnix_close(pTHX_ PerlIO *f)
2717 const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2719 if (PerlIOBase(f)->flags & PERLIO_F_OPEN) {
2720 if (PerlIOUnix_refcnt_dec(fd) > 0) {
2721 PerlIOBase(f)->flags &= ~PERLIO_F_OPEN;
2726 SETERRNO(EBADF,SS_IVCHAN);
2729 while (PerlLIO_close(fd) != 0) {
2730 if (errno != EINTR) {
2737 PerlIOBase(f)->flags &= ~PERLIO_F_OPEN;
2742 PERLIO_FUNCS_DECL(PerlIO_unix) = {
2743 sizeof(PerlIO_funcs),
2750 PerlIOBase_binmode, /* binmode */
2760 PerlIOBase_noop_ok, /* flush */
2761 PerlIOBase_noop_fail, /* fill */
2764 PerlIOBase_clearerr,
2765 PerlIOBase_setlinebuf,
2766 NULL, /* get_base */
2767 NULL, /* get_bufsiz */
2770 NULL, /* set_ptrcnt */
2773 /*--------------------------------------------------------------------------------------*/
2778 #if defined(VMS) && !defined(STDIO_BUFFER_WRITABLE)
2779 /* perl5.8 - This ensures the last minute VMS ungetc fix is not
2780 broken by the last second glibc 2.3 fix
2782 #define STDIO_BUFFER_WRITABLE
2787 struct _PerlIO base;
2788 FILE *stdio; /* The stream */
2792 PerlIOStdio_fileno(pTHX_ PerlIO *f)
2794 PERL_UNUSED_CONTEXT;
2796 if (PerlIOValid(f)) {
2797 FILE * const s = PerlIOSelf(f, PerlIOStdio)->stdio;
2799 return PerlSIO_fileno(s);
2806 PerlIOStdio_mode(const char *mode, char *tmode)
2808 char * const ret = tmode;
2814 #if defined(PERLIO_USING_CRLF) || defined(__CYGWIN__)
2822 PerlIOStdio_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2825 if (PerlIOValid(f) && PerlIOValid(n = PerlIONext(f))) {
2826 PerlIO_funcs * const toptab = PerlIOBase(n)->tab;
2827 if (toptab == tab) {
2828 /* Top is already stdio - pop self (duplicate) and use original */
2829 PerlIO_pop(aTHX_ f);
2832 const int fd = PerlIO_fileno(n);
2835 if (fd >= 0 && (stdio = PerlSIO_fdopen(fd,
2836 mode = PerlIOStdio_mode(mode, tmode)))) {
2837 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2838 /* We never call down so do any pending stuff now */
2839 PerlIO_flush(PerlIONext(f));
2846 return PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
2851 PerlIO_importFILE(FILE *stdio, const char *mode)
2857 if (!mode || !*mode) {
2858 /* We need to probe to see how we can open the stream
2859 so start with read/write and then try write and read
2860 we dup() so that we can fclose without loosing the fd.
2862 Note that the errno value set by a failing fdopen
2863 varies between stdio implementations.
2865 const int fd = PerlLIO_dup(fileno(stdio));
2866 FILE *f2 = PerlSIO_fdopen(fd, (mode = "r+"));
2868 f2 = PerlSIO_fdopen(fd, (mode = "w"));
2871 f2 = PerlSIO_fdopen(fd, (mode = "r"));
2874 /* Don't seem to be able to open */
2880 if ((f = PerlIO_push(aTHX_(f = PerlIO_allocate(aTHX)), PERLIO_FUNCS_CAST(&PerlIO_stdio), mode, NULL))) {
2881 s = PerlIOSelf(f, PerlIOStdio);
2883 PerlIOUnix_refcnt_inc(fileno(stdio));
2890 PerlIOStdio_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
2891 IV n, const char *mode, int fd, int imode,
2892 int perm, PerlIO *f, int narg, SV **args)
2895 if (PerlIOValid(f)) {
2896 const char * const path = SvPV_nolen_const(*args);
2897 PerlIOStdio * const s = PerlIOSelf(f, PerlIOStdio);
2899 PerlIOUnix_refcnt_dec(fileno(s->stdio));
2900 stdio = PerlSIO_freopen(path, (mode = PerlIOStdio_mode(mode, tmode)),
2905 PerlIOUnix_refcnt_inc(fileno(s->stdio));
2910 const char * const path = SvPV_nolen_const(*args);
2911 if (*mode == IoTYPE_NUMERIC) {
2913 fd = PerlLIO_open3(path, imode, perm);
2917 bool appended = FALSE;
2919 /* Cygwin wants its 'b' early. */
2921 mode = PerlIOStdio_mode(mode, tmode);
2923 stdio = PerlSIO_fopen(path, mode);
2926 f = PerlIO_allocate(aTHX);
2929 mode = PerlIOStdio_mode(mode, tmode);
2930 f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg);
2932 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2933 PerlIOUnix_refcnt_inc(fileno(stdio));
2935 PerlSIO_fclose(stdio);
2947 if (*mode == IoTYPE_IMPLICIT) {
2954 stdio = PerlSIO_stdin;
2957 stdio = PerlSIO_stdout;
2960 stdio = PerlSIO_stderr;
2965 stdio = PerlSIO_fdopen(fd, mode =
2966 PerlIOStdio_mode(mode, tmode));
2970 f = PerlIO_allocate(aTHX);
2972 if ((f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg))) {
2973 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2974 PerlIOUnix_refcnt_inc(fileno(stdio));
2984 PerlIOStdio_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2986 /* This assumes no layers underneath - which is what
2987 happens, but is not how I remember it. NI-S 2001/10/16
2989 if ((f = PerlIOBase_dup(aTHX_ f, o, param, flags))) {
2990 FILE *stdio = PerlIOSelf(o, PerlIOStdio)->stdio;
2991 const int fd = fileno(stdio);
2993 if (flags & PERLIO_DUP_FD) {
2994 const int dfd = PerlLIO_dup(fileno(stdio));
2996 stdio = PerlSIO_fdopen(dfd, PerlIO_modestr(o,mode));
3001 /* FIXME: To avoid messy error recovery if dup fails
3002 re-use the existing stdio as though flag was not set
3006 stdio = PerlSIO_fdopen(fd, PerlIO_modestr(o,mode));
3008 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
3009 PerlIOUnix_refcnt_inc(fileno(stdio));
3015 PerlIOStdio_invalidate_fileno(pTHX_ FILE *f)
3017 PERL_UNUSED_CONTEXT;
3019 /* XXX this could use PerlIO_canset_fileno() and
3020 * PerlIO_set_fileno() support from Configure
3022 # if defined(__UCLIBC__)
3023 /* uClibc must come before glibc because it defines __GLIBC__ as well. */
3026 # elif defined(__GLIBC__)
3027 /* There may be a better way for GLIBC:
3028 - libio.h defines a flag to not close() on cleanup
3032 # elif defined(__sun__)
3035 # elif defined(__hpux)
3039 /* Next one ->_file seems to be a reasonable fallback, i.e. if
3040 your platform does not have special entry try this one.
3041 [For OSF only have confirmation for Tru64 (alpha)
3042 but assume other OSFs will be similar.]
3044 # elif defined(_AIX) || defined(__osf__) || defined(__irix__)
3047 # elif defined(__FreeBSD__)
3048 /* There may be a better way on FreeBSD:
3049 - we could insert a dummy func in the _close function entry
3050 f->_close = (int (*)(void *)) dummy_close;
3054 # elif defined(__OpenBSD__)
3055 /* There may be a better way on OpenBSD:
3056 - we could insert a dummy func in the _close function entry
3057 f->_close = (int (*)(void *)) dummy_close;
3061 # elif defined(__EMX__)
3062 /* f->_flags &= ~_IOOPEN; */ /* Will leak stream->_buffer */
3065 # elif defined(__CYGWIN__)
3066 /* There may be a better way on CYGWIN:
3067 - we could insert a dummy func in the _close function entry
3068 f->_close = (int (*)(void *)) dummy_close;
3072 # elif defined(WIN32)
3073 # if defined(__BORLANDC__)
3074 f->fd = PerlLIO_dup(fileno(f));
3075 # elif defined(UNDER_CE)
3076 /* WIN_CE does not have access to FILE internals, it hardly has FILE
3085 /* Sarathy's code did this - we fall back to a dup/dup2 hack
3086 (which isn't thread safe) instead
3088 # error "Don't know how to set FILE.fileno on your platform"
3096 PerlIOStdio_close(pTHX_ PerlIO *f)
3098 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3104 const int fd = fileno(stdio);
3109 #ifdef SOCKS5_VERSION_NAME
3110 /* Socks lib overrides close() but stdio isn't linked to
3111 that library (though we are) - so we must call close()
3112 on sockets on stdio's behalf.
3115 Sock_size_t optlen = sizeof(int);
3116 if (getsockopt(fd, SOL_SOCKET, SO_TYPE, (void *) &optval, &optlen) == 0)
3119 if (PerlIOUnix_refcnt_dec(fd) > 0) /* File descriptor still in use */
3122 /* For STD* handles, don't close stdio, since we shared the FILE *, too. */
3123 if (stdio == stdin) /* Some stdios are buggy fflush-ing inputs */
3125 if (stdio == stdout || stdio == stderr)
3126 return PerlIO_flush(f);
3127 /* Tricky - must fclose(stdio) to free memory but not close(fd)
3128 Use Sarathy's trick from maint-5.6 to invalidate the
3129 fileno slot of the FILE *
3131 result = PerlIO_flush(f);
3133 invalidate = PerlIOStdio_invalidate_fileno(aTHX_ stdio);
3135 dupfd = PerlLIO_dup(fd);
3137 result = PerlSIO_fclose(stdio);
3138 /* We treat error from stdio as success if we invalidated
3139 errno may NOT be expected EBADF
3141 if (invalidate && result != 0) {
3145 #ifdef SOCKS5_VERSION_NAME
3146 /* in SOCKS' case, let close() determine return value */
3150 PerlLIO_dup2(dupfd,fd);
3151 PerlLIO_close(dupfd);
3158 PerlIOStdio_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
3161 FILE * const s = PerlIOSelf(f, PerlIOStdio)->stdio;
3165 STDCHAR *buf = (STDCHAR *) vbuf;
3167 * Perl is expecting PerlIO_getc() to fill the buffer Linux's
3168 * stdio does not do that for fread()
3170 const int ch = PerlSIO_fgetc(s);
3177 got = PerlSIO_fread(vbuf, 1, count, s);
3178 if (got == 0 && PerlSIO_ferror(s))
3180 if (got >= 0 || errno != EINTR)
3183 SETERRNO(0,0); /* just in case */
3189 PerlIOStdio_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3192 FILE * const s = PerlIOSelf(f, PerlIOStdio)->stdio;
3194 #ifdef STDIO_BUFFER_WRITABLE
3195 if (PerlIO_fast_gets(f) && PerlIO_has_base(f)) {
3196 STDCHAR *buf = ((STDCHAR *) vbuf) + count;
3197 STDCHAR *base = PerlIO_get_base(f);
3198 SSize_t cnt = PerlIO_get_cnt(f);
3199 STDCHAR *ptr = PerlIO_get_ptr(f);
3200 SSize_t avail = ptr - base;
3202 if (avail > count) {
3206 Move(buf-avail,ptr,avail,STDCHAR);
3209 PerlIO_set_ptrcnt(f,ptr,cnt+avail);
3210 if (PerlSIO_feof(s) && unread >= 0)
3211 PerlSIO_clearerr(s);
3216 if (PerlIO_has_cntptr(f)) {
3217 /* We can get pointer to buffer but not its base
3218 Do ungetc() but check chars are ending up in the
3221 STDCHAR *eptr = (STDCHAR*)PerlSIO_get_ptr(s);
3222 STDCHAR *buf = ((STDCHAR *) vbuf) + count;
3224 const int ch = *--buf & 0xFF;
3225 if (ungetc(ch,s) != ch) {
3226 /* ungetc did not work */
3229 if ((STDCHAR*)PerlSIO_get_ptr(s) != --eptr || ((*eptr & 0xFF) != ch)) {
3230 /* Did not change pointer as expected */
3231 fgetc(s); /* get char back again */
3241 unread += PerlIOBase_unread(aTHX_ f, vbuf, count);
3247 PerlIOStdio_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3252 got = PerlSIO_fwrite(vbuf, 1, count,
3253 PerlIOSelf(f, PerlIOStdio)->stdio);
3254 if (got >= 0 || errno != EINTR)
3257 SETERRNO(0,0); /* just in case */
3263 PerlIOStdio_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3265 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3266 PERL_UNUSED_CONTEXT;
3268 return PerlSIO_fseek(stdio, offset, whence);
3272 PerlIOStdio_tell(pTHX_ PerlIO *f)
3274 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3275 PERL_UNUSED_CONTEXT;
3277 return PerlSIO_ftell(stdio);
3281 PerlIOStdio_flush(pTHX_ PerlIO *f)
3283 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3284 PERL_UNUSED_CONTEXT;
3286 if (PerlIOBase(f)->flags & PERLIO_F_CANWRITE) {
3287 return PerlSIO_fflush(stdio);
3293 * FIXME: This discards ungetc() and pre-read stuff which is not
3294 * right if this is just a "sync" from a layer above Suspect right
3295 * design is to do _this_ but not have layer above flush this
3296 * layer read-to-read
3299 * Not writeable - sync by attempting a seek
3301 const int err = errno;
3302 if (PerlSIO_fseek(stdio, (Off_t) 0, SEEK_CUR) != 0)
3310 PerlIOStdio_eof(pTHX_ PerlIO *f)
3312 PERL_UNUSED_CONTEXT;
3314 return PerlSIO_feof(PerlIOSelf(f, PerlIOStdio)->stdio);
3318 PerlIOStdio_error(pTHX_ PerlIO *f)
3320 PERL_UNUSED_CONTEXT;
3322 return PerlSIO_ferror(PerlIOSelf(f, PerlIOStdio)->stdio);
3326 PerlIOStdio_clearerr(pTHX_ PerlIO *f)
3328 PERL_UNUSED_CONTEXT;
3330 PerlSIO_clearerr(PerlIOSelf(f, PerlIOStdio)->stdio);
3334 PerlIOStdio_setlinebuf(pTHX_ PerlIO *f)
3336 PERL_UNUSED_CONTEXT;
3338 #ifdef HAS_SETLINEBUF
3339 PerlSIO_setlinebuf(PerlIOSelf(f, PerlIOStdio)->stdio);
3341 PerlSIO_setvbuf(PerlIOSelf(f, PerlIOStdio)->stdio, NULL, _IOLBF, 0);
3347 PerlIOStdio_get_base(pTHX_ PerlIO *f)
3349 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3350 return (STDCHAR*)PerlSIO_get_base(stdio);
3354 PerlIOStdio_get_bufsiz(pTHX_ PerlIO *f)
3356 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3357 return PerlSIO_get_bufsiz(stdio);
3361 #ifdef USE_STDIO_PTR
3363 PerlIOStdio_get_ptr(pTHX_ PerlIO *f)
3365 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3366 return (STDCHAR*)PerlSIO_get_ptr(stdio);
3370 PerlIOStdio_get_cnt(pTHX_ PerlIO *f)
3372 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3373 return PerlSIO_get_cnt(stdio);
3377 PerlIOStdio_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
3379 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3381 #ifdef STDIO_PTR_LVALUE
3382 PerlSIO_set_ptr(stdio, ptr); /* LHS STDCHAR* cast non-portable */
3383 #ifdef STDIO_PTR_LVAL_SETS_CNT
3384 if (PerlSIO_get_cnt(stdio) != (cnt)) {
3385 assert(PerlSIO_get_cnt(stdio) == (cnt));
3388 #if (!defined(STDIO_PTR_LVAL_NOCHANGE_CNT))
3390 * Setting ptr _does_ change cnt - we are done
3394 #else /* STDIO_PTR_LVALUE */
3396 #endif /* STDIO_PTR_LVALUE */
3399 * Now (or only) set cnt
3401 #ifdef STDIO_CNT_LVALUE
3402 PerlSIO_set_cnt(stdio, cnt);
3403 #else /* STDIO_CNT_LVALUE */
3404 #if (defined(STDIO_PTR_LVALUE) && defined(STDIO_PTR_LVAL_SETS_CNT))
3405 PerlSIO_set_ptr(stdio,
3406 PerlSIO_get_ptr(stdio) + (PerlSIO_get_cnt(stdio) -
3408 #else /* STDIO_PTR_LVAL_SETS_CNT */
3410 #endif /* STDIO_PTR_LVAL_SETS_CNT */
3411 #endif /* STDIO_CNT_LVALUE */
3418 PerlIOStdio_fill(pTHX_ PerlIO *f)
3420 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3422 PERL_UNUSED_CONTEXT;
3425 * fflush()ing read-only streams can cause trouble on some stdio-s
3427 if ((PerlIOBase(f)->flags & PERLIO_F_CANWRITE)) {
3428 if (PerlSIO_fflush(stdio) != 0)
3432 c = PerlSIO_fgetc(stdio);
3435 if (! PerlSIO_ferror(stdio) || errno != EINTR)
3441 #if (defined(STDIO_PTR_LVALUE) && (defined(STDIO_CNT_LVALUE) || defined(STDIO_PTR_LVAL_SETS_CNT)))
3443 #ifdef STDIO_BUFFER_WRITABLE
3444 if (PerlIO_fast_gets(f) && PerlIO_has_base(f)) {
3445 /* Fake ungetc() to the real buffer in case system's ungetc
3448 STDCHAR *base = (STDCHAR*)PerlSIO_get_base(stdio);
3449 SSize_t cnt = PerlSIO_get_cnt(stdio);
3450 STDCHAR *ptr = (STDCHAR*)PerlSIO_get_ptr(stdio);
3451 if (ptr == base+1) {
3452 *--ptr = (STDCHAR) c;
3453 PerlIOStdio_set_ptrcnt(aTHX_ f,ptr,cnt+1);
3454 if (PerlSIO_feof(stdio))
3455 PerlSIO_clearerr(stdio);
3461 if (PerlIO_has_cntptr(f)) {
3463 if (PerlIOStdio_unread(aTHX_ f,&ch,1) == 1) {
3470 /* An ungetc()d char is handled separately from the regular
3471 * buffer, so we stuff it in the buffer ourselves.
3472 * Should never get called as should hit code above
3474 *(--((*stdio)->_ptr)) = (unsigned char) c;
3477 /* If buffer snoop scheme above fails fall back to
3480 if (PerlSIO_ungetc(c, stdio) != c)
3488 PERLIO_FUNCS_DECL(PerlIO_stdio) = {
3489 sizeof(PerlIO_funcs),
3491 sizeof(PerlIOStdio),
3492 PERLIO_K_BUFFERED|PERLIO_K_RAW,
3496 PerlIOBase_binmode, /* binmode */
3510 PerlIOStdio_clearerr,
3511 PerlIOStdio_setlinebuf,
3513 PerlIOStdio_get_base,
3514 PerlIOStdio_get_bufsiz,
3519 #ifdef USE_STDIO_PTR
3520 PerlIOStdio_get_ptr,
3521 PerlIOStdio_get_cnt,
3522 # if defined(HAS_FAST_STDIO) && defined(USE_FAST_STDIO)
3523 PerlIOStdio_set_ptrcnt,
3526 # endif /* HAS_FAST_STDIO && USE_FAST_STDIO */
3531 #endif /* USE_STDIO_PTR */
3534 /* Note that calls to PerlIO_exportFILE() are reversed using
3535 * PerlIO_releaseFILE(), not importFILE. */
3537 PerlIO_exportFILE(PerlIO * f, const char *mode)
3541 if (PerlIOValid(f)) {
3544 if (!mode || !*mode) {
3545 mode = PerlIO_modestr(f, buf);
3547 stdio = PerlSIO_fdopen(PerlIO_fileno(f), mode);
3551 /* De-link any lower layers so new :stdio sticks */
3553 if ((f2 = PerlIO_push(aTHX_ f, PERLIO_FUNCS_CAST(&PerlIO_stdio), buf, NULL))) {
3554 PerlIOStdio *s = PerlIOSelf((f = f2), PerlIOStdio);
3556 PerlIOUnix_refcnt_inc(fileno(stdio));
3557 /* Link previous lower layers under new one */
3561 /* restore layers list */
3571 PerlIO_findFILE(PerlIO *f)
3575 if (l->tab == &PerlIO_stdio) {
3576 PerlIOStdio *s = PerlIOSelf(&l, PerlIOStdio);
3579 l = *PerlIONext(&l);
3581 /* Uses fallback "mode" via PerlIO_modestr() in PerlIO_exportFILE */
3582 return PerlIO_exportFILE(f, NULL);
3585 /* Use this to reverse PerlIO_exportFILE calls. */
3587 PerlIO_releaseFILE(PerlIO *p, FILE *f)
3592 if (l->tab == &PerlIO_stdio) {
3593 PerlIOStdio *s = PerlIOSelf(&l, PerlIOStdio);
3594 if (s->stdio == f) {
3596 const int fd = fileno(f);
3598 PerlIOUnix_refcnt_dec(fd);
3599 PerlIO_pop(aTHX_ p);
3608 /*--------------------------------------------------------------------------------------*/
3610 * perlio buffer layer
3614 PerlIOBuf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
3616 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3617 const int fd = PerlIO_fileno(f);
3618 if (fd >= 0 && PerlLIO_isatty(fd)) {
3619 PerlIOBase(f)->flags |= PERLIO_F_LINEBUF | PERLIO_F_TTY;
3621 if (*PerlIONext(f)) {
3622 const Off_t posn = PerlIO_tell(PerlIONext(f));
3623 if (posn != (Off_t) - 1) {
3627 return PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
3631 PerlIOBuf_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
3632 IV n, const char *mode, int fd, int imode, int perm,
3633 PerlIO *f, int narg, SV **args)
3635 if (PerlIOValid(f)) {
3636 PerlIO *next = PerlIONext(f);
3638 PerlIO_layer_fetch(aTHX_ layers, n - 1, PerlIOBase(next)->tab);
3639 if (tab && tab->Open)
3641 (*tab->Open)(aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
3643 if (!next || (*PerlIOBase(f)->tab->Pushed) (aTHX_ f, mode, PerlIOArg, self) != 0) {
3648 PerlIO_funcs *tab = PerlIO_layer_fetch(aTHX_ layers, n - 1, PerlIO_default_btm());
3650 if (*mode == IoTYPE_IMPLICIT) {
3656 if (tab && tab->Open)
3657 f = (*tab->Open)(aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
3660 SETERRNO(EINVAL, LIB_INVARG);
3662 if (PerlIO_push(aTHX_ f, self, mode, PerlIOArg) == 0) {
3664 * if push fails during open, open fails. close will pop us.
3669 fd = PerlIO_fileno(f);
3670 if (init && fd == 2) {
3672 * Initial stderr is unbuffered
3674 PerlIOBase(f)->flags |= PERLIO_F_UNBUF;
3676 #ifdef PERLIO_USING_CRLF
3677 # ifdef PERLIO_IS_BINMODE_FD
3678 if (PERLIO_IS_BINMODE_FD(fd))
3679 PerlIO_binmode(aTHX_ f, '<'/*not used*/, O_BINARY, NULL);
3683 * do something about failing setmode()? --jhi
3685 PerlLIO_setmode(fd, O_BINARY);
3694 * This "flush" is akin to sfio's sync in that it handles files in either
3695 * read or write state. For write state, we put the postponed data through
3696 * the next layers. For read state, we seek() the next layers to the
3697 * offset given by current position in the buffer, and discard the buffer
3698 * state (XXXX supposed to be for seek()able buffers only, but now it is done
3699 * in any case?). Then the pass the stick further in chain.
3702 PerlIOBuf_flush(pTHX_ PerlIO *f)
3704 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3706 PerlIO *n = PerlIONext(f);
3707 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF) {
3709 * write() the buffer
3711 const STDCHAR *buf = b->buf;
3712 const STDCHAR *p = buf;
3713 while (p < b->ptr) {
3714 SSize_t count = PerlIO_write(n, p, b->ptr - p);
3718 else if (count < 0 || PerlIO_error(n)) {
3719 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
3724 b->posn += (p - buf);
3726 else if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3727 STDCHAR *buf = PerlIO_get_base(f);
3729 * Note position change
3731 b->posn += (b->ptr - buf);
3732 if (b->ptr < b->end) {
3733 /* We did not consume all of it - try and seek downstream to
3734 our logical position
3736 if (PerlIOValid(n) && PerlIO_seek(n, b->posn, SEEK_SET) == 0) {
3737 /* Reload n as some layers may pop themselves on seek */
3738 b->posn = PerlIO_tell(n = PerlIONext(f));
3741 /* Seek failed (e.g. pipe or tty). Do NOT clear buffer or pre-read
3742 data is lost for good - so return saying "ok" having undone
3745 b->posn -= (b->ptr - buf);
3750 b->ptr = b->end = b->buf;
3751 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3752 /* We check for Valid because of dubious decision to make PerlIO_flush(NULL) flush all */
3753 if (PerlIOValid(n) && PerlIO_flush(n) != 0)
3758 /* This discards the content of the buffer after b->ptr, and rereads
3759 * the buffer from the position off in the layer downstream; here off
3760 * is at offset corresponding to b->ptr - b->buf.
3763 PerlIOBuf_fill(pTHX_ PerlIO *f)
3765 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3766 PerlIO *n = PerlIONext(f);
3769 * Down-stream flush is defined not to loose read data so is harmless.
3770 * we would not normally be fill'ing if there was data left in anycase.
3772 if (PerlIO_flush(f) != 0) /* XXXX Check that its seek() succeeded?! */
3774 if (PerlIOBase(f)->flags & PERLIO_F_TTY)
3775 PerlIOBase_flush_linebuf(aTHX);
3778 PerlIO_get_base(f); /* allocate via vtable */
3780 assert(b->buf); /* The b->buf does get allocated via the vtable system. */
3782 b->ptr = b->end = b->buf;
3784 if (!PerlIOValid(n)) {
3785 PerlIOBase(f)->flags |= PERLIO_F_EOF;
3789 if (PerlIO_fast_gets(n)) {
3791 * Layer below is also buffered. We do _NOT_ want to call its
3792 * ->Read() because that will loop till it gets what we asked for
3793 * which may hang on a pipe etc. Instead take anything it has to
3794 * hand, or ask it to fill _once_.
3796 avail = PerlIO_get_cnt(n);
3798 avail = PerlIO_fill(n);
3800 avail = PerlIO_get_cnt(n);
3802 if (!PerlIO_error(n) && PerlIO_eof(n))
3807 STDCHAR *ptr = PerlIO_get_ptr(n);
3808 const SSize_t cnt = avail;
3809 if (avail > (SSize_t)b->bufsiz)
3811 Copy(ptr, b->buf, avail, STDCHAR);
3812 PerlIO_set_ptrcnt(n, ptr + avail, cnt - avail);
3816 avail = PerlIO_read(n, b->ptr, b->bufsiz);
3820 PerlIOBase(f)->flags |= PERLIO_F_EOF;
3822 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
3825 b->end = b->buf + avail;
3826 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3831 PerlIOBuf_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
3833 if (PerlIOValid(f)) {
3834 const PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3837 return PerlIOBase_read(aTHX_ f, vbuf, count);
3843 PerlIOBuf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3845 const STDCHAR *buf = (const STDCHAR *) vbuf + count;
3846 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3849 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
3854 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3856 * Buffer is already a read buffer, we can overwrite any chars
3857 * which have been read back to buffer start
3859 avail = (b->ptr - b->buf);
3863 * Buffer is idle, set it up so whole buffer is available for
3867 b->end = b->buf + avail;
3869 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3871 * Buffer extends _back_ from where we are now
3873 b->posn -= b->bufsiz;
3875 if (avail > (SSize_t) count) {
3877 * If we have space for more than count, just move count
3885 * In simple stdio-like ungetc() case chars will be already
3888 if (buf != b->ptr) {
3889 Copy(buf, b->ptr, avail, STDCHAR);
3893 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
3897 unread += PerlIOBase_unread(aTHX_ f, vbuf, count);
3903 PerlIOBuf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3905 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3906 const STDCHAR *buf = (const STDCHAR *) vbuf;
3907 const STDCHAR *flushptr = buf;
3911 if (!(PerlIOBase(f)->flags & PERLIO_F_CANWRITE))
3913 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3914 if (PerlIO_flush(f) != 0) {
3918 if (PerlIOBase(f)->flags & PERLIO_F_LINEBUF) {
3919 flushptr = buf + count;
3920 while (flushptr > buf && *(flushptr - 1) != '\n')
3924 SSize_t avail = b->bufsiz - (b->ptr - b->buf);
3925 if ((SSize_t) count < avail)
3927 if (flushptr > buf && flushptr <= buf + avail)
3928 avail = flushptr - buf;
3929 PerlIOBase(f)->flags |= PERLIO_F_WRBUF;
3931 Copy(buf, b->ptr, avail, STDCHAR);
3936 if (buf == flushptr)
3939 if (b->ptr >= (b->buf + b->bufsiz))
3942 if (PerlIOBase(f)->flags & PERLIO_F_UNBUF)
3948 PerlIOBuf_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3951 if ((code = PerlIO_flush(f)) == 0) {
3952 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
3953 code = PerlIO_seek(PerlIONext(f), offset, whence);
3955 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3956 b->posn = PerlIO_tell(PerlIONext(f));
3963 PerlIOBuf_tell(pTHX_ PerlIO *f)
3965 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3967 * b->posn is file position where b->buf was read, or will be written
3969 Off_t posn = b->posn;
3970 if ((PerlIOBase(f)->flags & PERLIO_F_APPEND) &&
3971 (PerlIOBase(f)->flags & PERLIO_F_WRBUF)) {
3973 /* As O_APPEND files are normally shared in some sense it is better
3978 /* when file is NOT shared then this is sufficient */
3979 PerlIO_seek(PerlIONext(f),0, SEEK_END);
3981 posn = b->posn = PerlIO_tell(PerlIONext(f));
3985 * If buffer is valid adjust position by amount in buffer
3987 posn += (b->ptr - b->buf);
3993 PerlIOBuf_popped(pTHX_ PerlIO *f)
3995 const IV code = PerlIOBase_popped(aTHX_ f);
3996 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3997 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
4000 b->ptr = b->end = b->buf = NULL;
4001 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
4006 PerlIOBuf_close(pTHX_ PerlIO *f)
4008 const IV code = PerlIOBase_close(aTHX_ f);
4009 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4010 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
4013 b->ptr = b->end = b->buf = NULL;
4014 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
4019 PerlIOBuf_get_ptr(pTHX_ PerlIO *f)
4021 const PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4028 PerlIOBuf_get_cnt(pTHX_ PerlIO *f)
4030 const PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4033 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF)
4034 return (b->end - b->ptr);
4039 PerlIOBuf_get_base(pTHX_ PerlIO *f)
4041 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4042 PERL_UNUSED_CONTEXT;
4047 b->buf = Newxz(b->buf,b->bufsiz, STDCHAR);
4049 b->buf = (STDCHAR *) & b->oneword;
4050 b->bufsiz = sizeof(b->oneword);
4052 b->end = b->ptr = b->buf;
4058 PerlIOBuf_bufsiz(pTHX_ PerlIO *f)
4060 const PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4063 return (b->end - b->buf);
4067 PerlIOBuf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
4069 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4073 if (PerlIO_get_cnt(f) != cnt || b->ptr < b->buf) {
4074 assert(PerlIO_get_cnt(f) == cnt);
4075 assert(b->ptr >= b->buf);
4077 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4081 PerlIOBuf_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
4083 return PerlIOBase_dup(aTHX_ f, o, param, flags);
4088 PERLIO_FUNCS_DECL(PerlIO_perlio) = {
4089 sizeof(PerlIO_funcs),
4092 PERLIO_K_BUFFERED|PERLIO_K_RAW,
4096 PerlIOBase_binmode, /* binmode */
4110 PerlIOBase_clearerr,
4111 PerlIOBase_setlinebuf,
4116 PerlIOBuf_set_ptrcnt,
4119 /*--------------------------------------------------------------------------------------*/
4121 * Temp layer to hold unread chars when cannot do it any other way
4125 PerlIOPending_fill(pTHX_ PerlIO *f)
4128 * Should never happen
4135 PerlIOPending_close(pTHX_ PerlIO *f)
4138 * A tad tricky - flush pops us, then we close new top
4141 return PerlIO_close(f);
4145 PerlIOPending_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
4148 * A tad tricky - flush pops us, then we seek new top
4151 return PerlIO_seek(f, offset, whence);
4156 PerlIOPending_flush(pTHX_ PerlIO *f)
4158 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4159 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
4163 PerlIO_pop(aTHX_ f);
4168 PerlIOPending_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
4174 PerlIOBuf_set_ptrcnt(aTHX_ f, ptr, cnt);
4179 PerlIOPending_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
4181 const IV code = PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
4182 PerlIOl * const l = PerlIOBase(f);
4184 * Our PerlIO_fast_gets must match what we are pushed on, or sv_gets()
4185 * etc. get muddled when it changes mid-string when we auto-pop.
4187 l->flags = (l->flags & ~(PERLIO_F_FASTGETS | PERLIO_F_UTF8)) |
4188 (PerlIOBase(PerlIONext(f))->
4189 flags & (PERLIO_F_FASTGETS | PERLIO_F_UTF8));
4194 PerlIOPending_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
4196 SSize_t avail = PerlIO_get_cnt(f);
4198 if ((SSize_t)count < avail)
4201 got = PerlIOBuf_read(aTHX_ f, vbuf, avail);
4202 if (got >= 0 && got < (SSize_t)count) {
4203 const SSize_t more =
4204 PerlIO_read(f, ((STDCHAR *) vbuf) + got, count - got);
4205 if (more >= 0 || got == 0)
4211 PERLIO_FUNCS_DECL(PerlIO_pending) = {
4212 sizeof(PerlIO_funcs),
4215 PERLIO_K_BUFFERED|PERLIO_K_RAW, /* not sure about RAW here */
4216 PerlIOPending_pushed,
4219 PerlIOBase_binmode, /* binmode */
4228 PerlIOPending_close,
4229 PerlIOPending_flush,
4233 PerlIOBase_clearerr,
4234 PerlIOBase_setlinebuf,
4239 PerlIOPending_set_ptrcnt,
4244 /*--------------------------------------------------------------------------------------*/
4246 * crlf - translation On read translate CR,LF to "\n" we do this by
4247 * overriding ptr/cnt entries to hand back a line at a time and keeping a
4248 * record of which nl we "lied" about. On write translate "\n" to CR,LF
4250 * c->nl points on the first byte of CR LF pair when it is temporarily
4251 * replaced by LF, or to the last CR of the buffer. In the former case
4252 * the caller thinks that the buffer ends at c->nl + 1, in the latter
4253 * that it ends at c->nl; these two cases can be distinguished by
4254 * *c->nl. c->nl is set during _getcnt() call, and unset during
4255 * _unread() and _flush() calls.
4256 * It only matters for read operations.
4260 PerlIOBuf base; /* PerlIOBuf stuff */
4261 STDCHAR *nl; /* Position of crlf we "lied" about in the
4265 /* Inherit the PERLIO_F_UTF8 flag from previous layer.
4266 * Otherwise the :crlf layer would always revert back to
4270 S_inherit_utf8_flag(PerlIO *f)
4272 PerlIO *g = PerlIONext(f);
4273 if (PerlIOValid(g)) {
4274 if (PerlIOBase(g)->flags & PERLIO_F_UTF8) {
4275 PerlIOBase(f)->flags |= PERLIO_F_UTF8;
4281 PerlIOCrlf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
4284 PerlIOBase(f)->flags |= PERLIO_F_CRLF;
4285 code = PerlIOBuf_pushed(aTHX_ f, mode, arg, tab);
4287 PerlIO_debug("PerlIOCrlf_pushed f=%p %s %s fl=%08" UVxf "\n",
4288 (void*)f, PerlIOBase(f)->tab->name, (mode) ? mode : "(Null)",
4289 PerlIOBase(f)->flags);
4292 /* Enable the first CRLF capable layer you can find, but if none
4293 * found, the one we just pushed is fine. This results in at
4294 * any given moment at most one CRLF-capable layer being enabled
4295 * in the whole layer stack. */
4296 PerlIO *g = PerlIONext(f);
4297 while (PerlIOValid(g)) {
4298 PerlIOl *b = PerlIOBase(g);
4299 if (b && b->tab == &PerlIO_crlf) {
4300 if (!(b->flags & PERLIO_F_CRLF))
4301 b->flags |= PERLIO_F_CRLF;
4302 S_inherit_utf8_flag(g);
4303 PerlIO_pop(aTHX_ f);
4309 S_inherit_utf8_flag(f);
4315 PerlIOCrlf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4317 PerlIOCrlf * const c = PerlIOSelf(f, PerlIOCrlf);
4318 if (c->nl) { /* XXXX Shouldn't it be done only if b->ptr > c->nl? */
4322 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF))
4323 return PerlIOBuf_unread(aTHX_ f, vbuf, count);
4325 const STDCHAR *buf = (const STDCHAR *) vbuf + count;
4326 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4328 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
4333 if (!(PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4334 b->end = b->ptr = b->buf + b->bufsiz;
4335 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4336 b->posn -= b->bufsiz;
4338 while (count > 0 && b->ptr > b->buf) {
4339 const int ch = *--buf;
4341 if (b->ptr - 2 >= b->buf) {
4348 /* If b->ptr - 1 == b->buf, we are undoing reading 0xa */
4349 *--(b->ptr) = 0xa; /* Works even if 0xa == '\r' */
4365 /* XXXX This code assumes that buffer size >=2, but does not check it... */
4367 PerlIOCrlf_get_cnt(pTHX_ PerlIO *f)
4369 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4372 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
4373 PerlIOCrlf * const c = PerlIOSelf(f, PerlIOCrlf);
4374 if ((PerlIOBase(f)->flags & PERLIO_F_CRLF) && (!c->nl || *c->nl == 0xd)) {
4375 STDCHAR *nl = (c->nl) ? c->nl : b->ptr;
4377 while (nl < b->end && *nl != 0xd)
4379 if (nl < b->end && *nl == 0xd) {
4381 if (nl + 1 < b->end) {
4388 * Not CR,LF but just CR
4396 * Blast - found CR as last char in buffer
4401 * They may not care, defer work as long as
4405 return (nl - b->ptr);
4409 b->ptr++; /* say we have read it as far as
4410 * flush() is concerned */
4411 b->buf++; /* Leave space in front of buffer */
4412 /* Note as we have moved buf up flush's
4414 will naturally make posn point at CR
4416 b->bufsiz--; /* Buffer is thus smaller */
4417 code = PerlIO_fill(f); /* Fetch some more */
4418 b->bufsiz++; /* Restore size for next time */
4419 b->buf--; /* Point at space */
4420 b->ptr = nl = b->buf; /* Which is what we hand
4422 *nl = 0xd; /* Fill in the CR */
4424 goto test; /* fill() call worked */
4426 * CR at EOF - just fall through
4428 /* Should we clear EOF though ??? */
4433 return (((c->nl) ? (c->nl + 1) : b->end) - b->ptr);
4439 PerlIOCrlf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
4441 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4442 PerlIOCrlf * const c = PerlIOSelf(f, PerlIOCrlf);
4448 if (ptr == b->end && *c->nl == 0xd) {
4449 /* Defered CR at end of buffer case - we lied about count */
4462 * Test code - delete when it works ...
4464 IV flags = PerlIOBase(f)->flags;
4465 STDCHAR *chk = (c->nl) ? (c->nl+1) : b->end;
4466 if (ptr+cnt == c->nl && c->nl+1 == b->end && *c->nl == 0xd) {
4467 /* Defered CR at end of buffer case - we lied about count */
4473 Perl_croak(aTHX_ "ptr wrong %p != %p fl=%08" UVxf
4474 " nl=%p e=%p for %d", (void*)ptr, (void*)chk,
4475 flags, c->nl, b->end, cnt);
4482 * They have taken what we lied about
4490 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4494 PerlIOCrlf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4496 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF))
4497 return PerlIOBuf_write(aTHX_ f, vbuf, count);
4499 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4500 const STDCHAR *buf = (const STDCHAR *) vbuf;
4501 const STDCHAR * const ebuf = buf + count;
4504 if (!(PerlIOBase(f)->flags & PERLIO_F_CANWRITE))
4506 while (buf < ebuf) {
4507 const STDCHAR * const eptr = b->buf + b->bufsiz;
4508 PerlIOBase(f)->flags |= PERLIO_F_WRBUF;
4509 while (buf < ebuf && b->ptr < eptr) {
4511 if ((b->ptr + 2) > eptr) {
4519 *(b->ptr)++ = 0xd; /* CR */
4520 *(b->ptr)++ = 0xa; /* LF */
4522 if (PerlIOBase(f)->flags & PERLIO_F_LINEBUF) {
4529 *(b->ptr)++ = *buf++;
4531 if (b->ptr >= eptr) {
4537 if (PerlIOBase(f)->flags & PERLIO_F_UNBUF)
4539 return (buf - (STDCHAR *) vbuf);
4544 PerlIOCrlf_flush(pTHX_ PerlIO *f)
4546 PerlIOCrlf * const c = PerlIOSelf(f, PerlIOCrlf);
4551 return PerlIOBuf_flush(aTHX_ f);
4555 PerlIOCrlf_binmode(pTHX_ PerlIO *f)
4557 if ((PerlIOBase(f)->flags & PERLIO_F_CRLF)) {
4558 /* In text mode - flush any pending stuff and flip it */
4559 PerlIOBase(f)->flags &= ~PERLIO_F_CRLF;
4560 #ifndef PERLIO_USING_CRLF
4561 /* CRLF is unusual case - if this is just the :crlf layer pop it */
4562 if (PerlIOBase(f)->tab == &PerlIO_crlf) {
4563 PerlIO_pop(aTHX_ f);
4570 PERLIO_FUNCS_DECL(PerlIO_crlf) = {
4571 sizeof(PerlIO_funcs),
4574 PERLIO_K_BUFFERED | PERLIO_K_CANCRLF | PERLIO_K_RAW,
4576 PerlIOBuf_popped, /* popped */
4578 PerlIOCrlf_binmode, /* binmode */
4582 PerlIOBuf_read, /* generic read works with ptr/cnt lies */
4583 PerlIOCrlf_unread, /* Put CR,LF in buffer for each '\n' */
4584 PerlIOCrlf_write, /* Put CR,LF in buffer for each '\n' */
4592 PerlIOBase_clearerr,
4593 PerlIOBase_setlinebuf,
4598 PerlIOCrlf_set_ptrcnt,
4602 /*--------------------------------------------------------------------------------------*/
4604 * mmap as "buffer" layer
4608 PerlIOBuf base; /* PerlIOBuf stuff */
4609 Mmap_t mptr; /* Mapped address */
4610 Size_t len; /* mapped length */
4611 STDCHAR *bbuf; /* malloced buffer if map fails */
4615 PerlIOMmap_map(pTHX_ PerlIO *f)
4618 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4619 const IV flags = PerlIOBase(f)->flags;
4623 if (flags & PERLIO_F_CANREAD) {
4624 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4625 const int fd = PerlIO_fileno(f);
4627 code = Fstat(fd, &st);
4628 if (code == 0 && S_ISREG(st.st_mode)) {
4629 SSize_t len = st.st_size - b->posn;
4632 if (PL_mmap_page_size <= 0)
4633 Perl_croak(aTHX_ "panic: bad pagesize %" IVdf,
4637 * This is a hack - should never happen - open should
4640 b->posn = PerlIO_tell(PerlIONext(f));
4642 posn = (b->posn / PL_mmap_page_size) * PL_mmap_page_size;
4643 len = st.st_size - posn;
4644 m->mptr = (Mmap_t)mmap(NULL, len, PROT_READ, MAP_SHARED, fd, posn);
4645 if (m->mptr && m->mptr != (Mmap_t) - 1) {
4646 #if 0 && defined(HAS_MADVISE) && defined(MADV_SEQUENTIAL)
4647 madvise(m->mptr, len, MADV_SEQUENTIAL);
4649 #if 0 && defined(HAS_MADVISE) && defined(MADV_WILLNEED)
4650 madvise(m->mptr, len, MADV_WILLNEED);
4652 PerlIOBase(f)->flags =
4653 (flags & ~PERLIO_F_EOF) | PERLIO_F_RDBUF;
4654 b->end = ((STDCHAR *) m->mptr) + len;
4655 b->buf = ((STDCHAR *) m->mptr) + (b->posn - posn);
4664 PerlIOBase(f)->flags =
4665 flags | PERLIO_F_EOF | PERLIO_F_RDBUF;
4667 b->ptr = b->end = b->ptr;
4676 PerlIOMmap_unmap(pTHX_ PerlIO *f)
4678 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4681 PerlIOBuf * const b = &m->base;
4683 /* The munmap address argument is tricky: depending on the
4684 * standard it is either "void *" or "caddr_t" (which is
4685 * usually "char *" (signed or unsigned). If we cast it
4686 * to "void *", those that have it caddr_t and an uptight
4687 * C++ compiler, will freak out. But casting it as char*
4688 * should work. Maybe. (Using Mmap_t figured out by
4689 * Configure doesn't always work, apparently.) */
4690 code = munmap((char*)m->mptr, m->len);
4694 if (PerlIO_seek(PerlIONext(f), b->posn, SEEK_SET) != 0)
4697 b->ptr = b->end = b->buf;
4698 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
4704 PerlIOMmap_get_base(pTHX_ PerlIO *f)
4706 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4707 PerlIOBuf * const b = &m->base;
4708 if (b->buf && (PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4710 * Already have a readbuffer in progress
4716 * We have a write buffer or flushed PerlIOBuf read buffer
4718 m->bbuf = b->buf; /* save it in case we need it again */
4719 b->buf = NULL; /* Clear to trigger below */
4722 PerlIOMmap_map(aTHX_ f); /* Try and map it */
4725 * Map did not work - recover PerlIOBuf buffer if we have one
4730 b->ptr = b->end = b->buf;
4733 return PerlIOBuf_get_base(aTHX_ f);
4737 PerlIOMmap_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4739 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4740 PerlIOBuf * const b = &m->base;
4741 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
4743 if (b->ptr && (b->ptr - count) >= b->buf
4744 && memEQ(b->ptr - count, vbuf, count)) {
4746 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
4751 * Loose the unwritable mapped buffer
4755 * If flush took the "buffer" see if we have one from before
4757 if (!b->buf && m->bbuf)
4760 PerlIOBuf_get_base(aTHX_ f);
4764 return PerlIOBuf_unread(aTHX_ f, vbuf, count);
4768 PerlIOMmap_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4770 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4771 PerlIOBuf * const b = &m->base;
4773 if (!b->buf || !(PerlIOBase(f)->flags & PERLIO_F_WRBUF)) {
4775 * No, or wrong sort of, buffer
4778 if (PerlIOMmap_unmap(aTHX_ f) != 0)
4782 * If unmap took the "buffer" see if we have one from before
4784 if (!b->buf && m->bbuf)
4787 PerlIOBuf_get_base(aTHX_ f);
4791 return PerlIOBuf_write(aTHX_ f, vbuf, count);
4795 PerlIOMmap_flush(pTHX_ PerlIO *f)
4797 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4798 PerlIOBuf * const b = &m->base;
4799 IV code = PerlIOBuf_flush(aTHX_ f);
4801 * Now we are "synced" at PerlIOBuf level
4808 if (PerlIOMmap_unmap(aTHX_ f) != 0)
4813 * We seem to have a PerlIOBuf buffer which was not mapped
4814 * remember it in case we need one later
4823 PerlIOMmap_fill(pTHX_ PerlIO *f)
4825 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4826 IV code = PerlIO_flush(f);
4827 if (code == 0 && !b->buf) {
4828 code = PerlIOMmap_map(aTHX_ f);
4830 if (code == 0 && !(PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4831 code = PerlIOBuf_fill(aTHX_ f);
4837 PerlIOMmap_close(pTHX_ PerlIO *f)
4839 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4840 PerlIOBuf * const b = &m->base;
4841 IV code = PerlIO_flush(f);
4845 b->ptr = b->end = b->buf;
4847 if (PerlIOBuf_close(aTHX_ f) != 0)
4853 PerlIOMmap_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
4855 return PerlIOBase_dup(aTHX_ f, o, param, flags);
4859 PERLIO_FUNCS_DECL(PerlIO_mmap) = {
4860 sizeof(PerlIO_funcs),
4863 PERLIO_K_BUFFERED|PERLIO_K_RAW,
4867 PerlIOBase_binmode, /* binmode */
4881 PerlIOBase_clearerr,
4882 PerlIOBase_setlinebuf,
4883 PerlIOMmap_get_base,
4887 PerlIOBuf_set_ptrcnt,
4890 #endif /* HAS_MMAP */
4893 Perl_PerlIO_stdin(pTHX)
4897 PerlIO_stdstreams(aTHX);
4899 return &PL_perlio[1];
4903 Perl_PerlIO_stdout(pTHX)
4907 PerlIO_stdstreams(aTHX);
4909 return &PL_perlio[2];
4913 Perl_PerlIO_stderr(pTHX)
4917 PerlIO_stdstreams(aTHX);
4919 return &PL_perlio[3];
4922 /*--------------------------------------------------------------------------------------*/
4925 PerlIO_getname(PerlIO *f, char *buf)
4930 bool exported = FALSE;
4931 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
4933 stdio = PerlIO_exportFILE(f,0);
4937 name = fgetname(stdio, buf);
4938 if (exported) PerlIO_releaseFILE(f,stdio);
4943 PERL_UNUSED_ARG(buf);
4944 Perl_croak(aTHX_ "Don't know how to get file name");
4950 /*--------------------------------------------------------------------------------------*/
4952 * Functions which can be called on any kind of PerlIO implemented in
4956 #undef PerlIO_fdopen
4958 PerlIO_fdopen(int fd, const char *mode)
4961 return PerlIO_openn(aTHX_ NULL, mode, fd, 0, 0, NULL, 0, NULL);
4966 PerlIO_open(const char *path, const char *mode)
4969 SV *name = sv_2mortal(newSVpv(path, 0));
4970 return PerlIO_openn(aTHX_ NULL, mode, -1, 0, 0, NULL, 1, &name);
4973 #undef Perlio_reopen
4975 PerlIO_reopen(const char *path, const char *mode, PerlIO *f)
4978 SV *name = sv_2mortal(newSVpv(path,0));
4979 return PerlIO_openn(aTHX_ NULL, mode, -1, 0, 0, f, 1, &name);
4984 PerlIO_getc(PerlIO *f)
4988 if ( 1 == PerlIO_read(f, buf, 1) ) {
4989 return (unsigned char) buf[0];
4994 #undef PerlIO_ungetc
4996 PerlIO_ungetc(PerlIO *f, int ch)
5001 if (PerlIO_unread(f, &buf, 1) == 1)
5009 PerlIO_putc(PerlIO *f, int ch)
5013 return PerlIO_write(f, &buf, 1);
5018 PerlIO_puts(PerlIO *f, const char *s)
5021 return PerlIO_write(f, s, strlen(s));
5024 #undef PerlIO_rewind
5026 PerlIO_rewind(PerlIO *f)
5029 PerlIO_seek(f, (Off_t) 0, SEEK_SET);
5033 #undef PerlIO_vprintf
5035 PerlIO_vprintf(PerlIO *f, const char *fmt, va_list ap)
5044 Perl_va_copy(ap, apc);
5045 sv = vnewSVpvf(fmt, &apc);
5047 sv = vnewSVpvf(fmt, &ap);
5049 s = SvPV_const(sv, len);
5050 wrote = PerlIO_write(f, s, len);
5055 #undef PerlIO_printf
5057 PerlIO_printf(PerlIO *f, const char *fmt, ...)
5062 result = PerlIO_vprintf(f, fmt, ap);
5067 #undef PerlIO_stdoutf
5069 PerlIO_stdoutf(const char *fmt, ...)
5075 result = PerlIO_vprintf(PerlIO_stdout(), fmt, ap);
5080 #undef PerlIO_tmpfile
5082 PerlIO_tmpfile(void)
5087 const int fd = win32_tmpfd();
5089 f = PerlIO_fdopen(fd, "w+b");
5091 # if defined(HAS_MKSTEMP) && ! defined(VMS) && ! defined(OS2)
5092 SV * const sv = newSVpvs("/tmp/PerlIO_XXXXXX");
5094 * I have no idea how portable mkstemp() is ... NI-S
5096 const int fd = mkstemp(SvPVX(sv));
5098 f = PerlIO_fdopen(fd, "w+");
5100 PerlIOBase(f)->flags |= PERLIO_F_TEMP;
5101 PerlLIO_unlink(SvPVX_const(sv));
5104 # else /* !HAS_MKSTEMP, fallback to stdio tmpfile(). */
5105 FILE * const stdio = PerlSIO_tmpfile();
5108 f = PerlIO_fdopen(fileno(stdio), "w+");
5110 # endif /* else HAS_MKSTEMP */
5111 #endif /* else WIN32 */
5118 #endif /* USE_SFIO */
5119 #endif /* PERLIO_IS_STDIO */
5121 /*======================================================================================*/
5123 * Now some functions in terms of above which may be needed even if we are
5124 * not in true PerlIO mode
5127 Perl_PerlIO_context_layers(pTHX_ const char *mode)
5130 const char *direction = NULL;
5133 * Need to supply default layer info from open.pm
5139 if (mode && mode[0] != 'r') {
5140 if (PL_curcop->cop_hints & HINT_LEXICAL_IO_OUT)
5141 direction = "open>";
5143 if (PL_curcop->cop_hints & HINT_LEXICAL_IO_IN)
5144 direction = "open<";
5149 layers = Perl_refcounted_he_fetch(aTHX_ PL_curcop->cop_hints_hash,
5150 0, direction, 5, 0, 0);
5153 return SvOK(layers) ? SvPV_nolen_const(layers) : NULL;
5158 #undef PerlIO_setpos
5160 PerlIO_setpos(PerlIO *f, SV *pos)
5165 const Off_t * const posn = (Off_t *) SvPV(pos, len);
5166 if (f && len == sizeof(Off_t))
5167 return PerlIO_seek(f, *posn, SEEK_SET);
5169 SETERRNO(EINVAL, SS_IVCHAN);
5173 #undef PerlIO_setpos
5175 PerlIO_setpos(PerlIO *f, SV *pos)
5180 Fpos_t * const fpos = (Fpos_t *) SvPV(pos, len);
5181 if (f && len == sizeof(Fpos_t)) {
5182 #if defined(USE_64_BIT_STDIO) && defined(USE_FSETPOS64)
5183 return fsetpos64(f, fpos);
5185 return fsetpos(f, fpos);
5189 SETERRNO(EINVAL, SS_IVCHAN);
5195 #undef PerlIO_getpos
5197 PerlIO_getpos(PerlIO *f, SV *pos)
5200 Off_t posn = PerlIO_tell(f);
5201 sv_setpvn(pos, (char *) &posn, sizeof(posn));
5202 return (posn == (Off_t) - 1) ? -1 : 0;
5205 #undef PerlIO_getpos
5207 PerlIO_getpos(PerlIO *f, SV *pos)
5212 #if defined(USE_64_BIT_STDIO) && defined(USE_FSETPOS64)
5213 code = fgetpos64(f, &fpos);
5215 code = fgetpos(f, &fpos);
5217 sv_setpvn(pos, (char *) &fpos, sizeof(fpos));
5222 #if (defined(PERLIO_IS_STDIO) || !defined(USE_SFIO)) && !defined(HAS_VPRINTF)
5225 vprintf(char *pat, char *args)
5227 _doprnt(pat, args, stdout);
5228 return 0; /* wrong, but perl doesn't use the return
5233 vfprintf(FILE *fd, char *pat, char *args)
5235 _doprnt(pat, args, fd);
5236 return 0; /* wrong, but perl doesn't use the return
5242 #ifndef PerlIO_vsprintf
5244 PerlIO_vsprintf(char *s, int n, const char *fmt, va_list ap)
5247 const int val = my_vsnprintf(s, n > 0 ? n : 0, fmt, ap);
5248 PERL_UNUSED_CONTEXT;
5250 #ifndef PERL_MY_VSNPRINTF_GUARDED
5251 if (val < 0 || (n > 0 ? val >= n : 0)) {
5252 Perl_croak(aTHX_ "panic: my_vsnprintf overflow in PerlIO_vsprintf\n");
5259 #ifndef PerlIO_sprintf
5261 PerlIO_sprintf(char *s, int n, const char *fmt, ...)
5266 result = PerlIO_vsprintf(s, n, fmt, ap);
5274 * c-indentation-style: bsd
5276 * indent-tabs-mode: t
5279 * ex: set ts=8 sts=4 sw=4 noet: