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__)
139 ((FILE *) fp)->_flag |= _IOBIN;
141 ((FILE *) fp)->_flag &= ~_IOBIN;
148 if (PerlLIO_setmode(fp, mode) != -1) {
150 if (PerlLIO_setmode(fileno(fp), mode) != -1) {
152 # if defined(WIN32) && defined(__BORLANDC__)
154 * The translation mode of the stream is maintained independent
156 * the translation mode of the fd in the Borland RTL (heavy
157 * digging through their runtime sources reveal). User has to
159 * the mode explicitly for the stream (though they don't
161 * this anywhere). GSAR 97-5-24
167 fp->flags &= ~_F_BIN;
175 # if defined(USEMYBINMODE)
177 if (my_binmode(fp, iotype, mode) != FALSE)
183 PERL_UNUSED_ARG(iotype);
184 PERL_UNUSED_ARG(mode);
192 #define O_ACCMODE 3 /* Assume traditional implementation */
196 PerlIO_intmode2str(int rawmode, char *mode, int *writing)
198 const int result = rawmode & O_ACCMODE;
203 ptype = IoTYPE_RDONLY;
206 ptype = IoTYPE_WRONLY;
214 *writing = (result != O_RDONLY);
216 if (result == O_RDONLY) {
220 else if (rawmode & O_APPEND) {
222 if (result != O_WRONLY)
227 if (result == O_WRONLY)
234 if (rawmode & O_BINARY)
240 #ifndef PERLIO_LAYERS
242 PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode, const char *names)
244 if (!names || !*names
245 || strEQ(names, ":crlf")
246 || strEQ(names, ":raw")
247 || strEQ(names, ":bytes")
251 Perl_croak(aTHX_ "Cannot apply \"%s\" in non-PerlIO perl", names);
259 PerlIO_destruct(pTHX)
264 PerlIO_binmode(pTHX_ PerlIO *fp, int iotype, int mode, const char *names)
267 PERL_UNUSED_ARG(iotype);
268 PERL_UNUSED_ARG(mode);
269 PERL_UNUSED_ARG(names);
272 return perlsio_binmode(fp, iotype, mode);
277 PerlIO_fdupopen(pTHX_ PerlIO *f, CLONE_PARAMS *param, int flags)
279 #if defined(PERL_MICRO) || defined(__SYMBIAN32__)
282 #ifdef PERL_IMPLICIT_SYS
283 return PerlSIO_fdupopen(f);
286 return win32_fdupopen(f);
289 const int fd = PerlLIO_dup(PerlIO_fileno(f));
293 const int omode = djgpp_get_stream_mode(f);
295 const int omode = fcntl(fd, F_GETFL);
297 PerlIO_intmode2str(omode,mode,NULL);
298 /* the r+ is a hack */
299 return PerlIO_fdopen(fd, mode);
304 SETERRNO(EBADF, SS_IVCHAN);
314 * De-mux PerlIO_openn() into fdopen, freopen and fopen type entries
318 PerlIO_openn(pTHX_ const char *layers, const char *mode, int fd,
319 int imode, int perm, PerlIO *old, int narg, SV **args)
323 Perl_croak(aTHX_ "More than one argument to open");
325 if (*args == &PL_sv_undef)
326 return PerlIO_tmpfile();
328 const char *name = SvPV_nolen_const(*args);
329 if (*mode == IoTYPE_NUMERIC) {
330 fd = PerlLIO_open3(name, imode, perm);
332 return PerlIO_fdopen(fd, mode + 1);
335 return PerlIO_reopen(name, mode, old);
338 return PerlIO_open(name, mode);
343 return PerlIO_fdopen(fd, (char *) mode);
348 XS(XS_PerlIO__Layer__find)
352 Perl_croak(aTHX_ "Usage class->find(name[,load])");
354 const char * const name = SvPV_nolen_const(ST(1));
355 ST(0) = (strEQ(name, "crlf")
356 || strEQ(name, "raw")) ? &PL_sv_yes : &PL_sv_undef;
363 Perl_boot_core_PerlIO(pTHX)
365 newXS("PerlIO::Layer::find", XS_PerlIO__Layer__find, __FILE__);
371 #ifdef PERLIO_IS_STDIO
378 * Does nothing (yet) except force this file to be included in perl
379 * binary. That allows this file to force inclusion of other functions
380 * that may be required by loadable extensions e.g. for
381 * FileHandle::tmpfile
385 #undef PerlIO_tmpfile
392 #else /* PERLIO_IS_STDIO */
400 * This section is just to make sure these functions get pulled in from
404 #undef PerlIO_tmpfile
416 * Force this file to be included in perl binary. Which allows this
417 * file to force inclusion of other functions that may be required by
418 * loadable extensions e.g. for FileHandle::tmpfile
422 * Hack sfio does its own 'autoflush' on stdout in common cases. Flush
423 * results in a lot of lseek()s to regular files and lot of small
426 sfset(sfstdout, SF_SHARE, 0);
429 /* This is not the reverse of PerlIO_exportFILE(), PerlIO_releaseFILE() is. */
431 PerlIO_importFILE(FILE *stdio, const char *mode)
433 const int fd = fileno(stdio);
434 if (!mode || !*mode) {
437 return PerlIO_fdopen(fd, mode);
441 PerlIO_findFILE(PerlIO *pio)
443 const int fd = PerlIO_fileno(pio);
444 FILE * const f = fdopen(fd, "r+");
446 if (!f && errno == EINVAL)
448 if (!f && errno == EINVAL)
455 /*======================================================================================*/
457 * Implement all the PerlIO interface ourselves.
463 * We _MUST_ have <unistd.h> if we are using lseek() and may have large
470 #include <sys/mman.h>
474 PerlIO_debug(const char *fmt, ...)
479 if (!PL_perlio_debug_fd) {
480 if (!PL_tainting && PL_uid == PL_euid && PL_gid == PL_egid) {
481 const char * const s = PerlEnv_getenv("PERLIO_DEBUG");
484 = PerlLIO_open3(s, O_WRONLY | O_CREAT | O_APPEND, 0666);
486 PL_perlio_debug_fd = -1;
488 /* tainting or set*id, so ignore the environment, and ensure we
489 skip these tests next time through. */
490 PL_perlio_debug_fd = -1;
493 if (PL_perlio_debug_fd > 0) {
496 const char * const s = CopFILE(PL_curcop);
497 /* Use fixed buffer as sv_catpvf etc. needs SVs */
499 const STRLEN len1 = my_snprintf(buffer, sizeof(buffer), "%.40s:%" IVdf " ", s ? s : "(none)", (IV) CopLINE(PL_curcop));
500 const STRLEN len2 = my_vsnprintf(buffer + len1, sizeof(buffer) - len1, fmt, ap);
501 PerlLIO_write(PL_perlio_debug_fd, buffer, len1 + len2);
503 const char *s = CopFILE(PL_curcop);
505 SV * const sv = newSVpvs("");
506 Perl_sv_catpvf(aTHX_ sv, "%s:%" IVdf " ", s ? s : "(none)",
507 (IV) CopLINE(PL_curcop));
508 Perl_sv_vcatpvf(aTHX_ sv, fmt, &ap);
510 s = SvPV_const(sv, len);
511 PerlLIO_write(PL_perlio_debug_fd, s, len);
518 /*--------------------------------------------------------------------------------------*/
521 * Inner level routines
525 * Table of pointers to the PerlIO structs (malloc'ed)
527 #define PERLIO_TABLE_SIZE 64
530 PerlIO_allocate(pTHX)
534 * Find a free slot in the table, allocating new table as necessary
539 while ((f = *last)) {
541 last = (PerlIO **) (f);
542 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
548 Newxz(f,PERLIO_TABLE_SIZE,PerlIO);
556 #undef PerlIO_fdupopen
558 PerlIO_fdupopen(pTHX_ PerlIO *f, CLONE_PARAMS *param, int flags)
560 if (PerlIOValid(f)) {
561 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;
562 PerlIO_debug("fdupopen f=%p param=%p\n",(void*)f,(void*)param);
564 return (*tab->Dup)(aTHX_ PerlIO_allocate(aTHX), f, param, flags);
566 return PerlIOBase_dup(aTHX_ PerlIO_allocate(aTHX), f, param, flags);
570 SETERRNO(EBADF, SS_IVCHAN);
576 PerlIO_cleantable(pTHX_ PerlIO **tablep)
578 PerlIO * const table = *tablep;
581 PerlIO_cleantable(aTHX_(PerlIO **) & (table[0]));
582 for (i = PERLIO_TABLE_SIZE - 1; i > 0; i--) {
583 PerlIO * const f = table + i;
595 PerlIO_list_alloc(pTHX)
599 Newxz(list, 1, PerlIO_list_t);
605 PerlIO_list_free(pTHX_ PerlIO_list_t *list)
608 if (--list->refcnt == 0) {
611 for (i = 0; i < list->cur; i++) {
612 if (list->array[i].arg)
613 SvREFCNT_dec(list->array[i].arg);
615 Safefree(list->array);
623 PerlIO_list_push(pTHX_ PerlIO_list_t *list, PerlIO_funcs *funcs, SV *arg)
629 if (list->cur >= list->len) {
632 Renew(list->array, list->len, PerlIO_pair_t);
634 Newx(list->array, list->len, PerlIO_pair_t);
636 p = &(list->array[list->cur++]);
638 if ((p->arg = arg)) {
639 SvREFCNT_inc_simple_void_NN(arg);
644 PerlIO_clone_list(pTHX_ PerlIO_list_t *proto, CLONE_PARAMS *param)
646 PerlIO_list_t *list = NULL;
649 list = PerlIO_list_alloc(aTHX);
650 for (i=0; i < proto->cur; i++) {
651 SV *arg = proto->array[i].arg;
654 arg = sv_dup(arg, param);
656 PERL_UNUSED_ARG(param);
658 PerlIO_list_push(aTHX_ list, proto->array[i].funcs, arg);
665 PerlIO_clone(pTHX_ PerlInterpreter *proto, CLONE_PARAMS *param)
668 PerlIO **table = &proto->Iperlio;
671 PL_known_layers = PerlIO_clone_list(aTHX_ proto->Iknown_layers, param);
672 PL_def_layerlist = PerlIO_clone_list(aTHX_ proto->Idef_layerlist, param);
673 PerlIO_allocate(aTHX); /* root slot is never used */
674 PerlIO_debug("Clone %p from %p\n",(void*)aTHX,(void*)proto);
675 while ((f = *table)) {
677 table = (PerlIO **) (f++);
678 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
680 (void) fp_dup(f, 0, param);
687 PERL_UNUSED_ARG(proto);
688 PERL_UNUSED_ARG(param);
693 PerlIO_destruct(pTHX)
696 PerlIO **table = &PL_perlio;
699 PerlIO_debug("Destruct %p\n",(void*)aTHX);
701 while ((f = *table)) {
703 table = (PerlIO **) (f++);
704 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
708 if (l->tab->kind & PERLIO_K_DESTRUCT) {
709 PerlIO_debug("Destruct popping %s\n", l->tab->name);
723 PerlIO_pop(pTHX_ PerlIO *f)
725 const PerlIOl *l = *f;
727 PerlIO_debug("PerlIO_pop f=%p %s\n", (void*)f, l->tab->name);
728 if (l->tab->Popped) {
730 * If popped returns non-zero do not free its layer structure
731 * it has either done so itself, or it is shared and still in
734 if ((*l->tab->Popped) (aTHX_ f) != 0)
742 /* Return as an array the stack of layers on a filehandle. Note that
743 * the stack is returned top-first in the array, and there are three
744 * times as many array elements as there are layers in the stack: the
745 * first element of a layer triplet is the name, the second one is the
746 * arguments, and the third one is the flags. */
749 PerlIO_get_layers(pTHX_ PerlIO *f)
752 AV * const av = newAV();
754 if (PerlIOValid(f)) {
755 PerlIOl *l = PerlIOBase(f);
758 SV * const name = l->tab && l->tab->name ?
759 newSVpv(l->tab->name, 0) : &PL_sv_undef;
760 SV * const arg = l->tab && l->tab->Getarg ?
761 (*l->tab->Getarg)(aTHX_ &l, 0, 0) : &PL_sv_undef;
764 av_push(av, newSViv((IV)l->flags));
772 /*--------------------------------------------------------------------------------------*/
774 * XS Interface for perl code
778 PerlIO_find_layer(pTHX_ const char *name, STRLEN len, int load)
782 if ((SSize_t) len <= 0)
784 for (i = 0; i < PL_known_layers->cur; i++) {
785 PerlIO_funcs * const f = PL_known_layers->array[i].funcs;
786 if (memEQ(f->name, name, len) && f->name[len] == 0) {
787 PerlIO_debug("%.*s => %p\n", (int) len, name, (void*)f);
791 if (load && PL_subname && PL_def_layerlist
792 && PL_def_layerlist->cur >= 2) {
793 if (PL_in_load_module) {
794 Perl_croak(aTHX_ "Recursive call to Perl_load_module in PerlIO_find_layer");
797 SV * const pkgsv = newSVpvs("PerlIO");
798 SV * const layer = newSVpvn(name, len);
799 CV * const cv = Perl_get_cvn_flags(aTHX_ STR_WITH_LEN("PerlIO::Layer::NoWarnings"), 0);
801 SAVEINT(PL_in_load_module);
803 SAVEGENERICSV(PL_warnhook);
804 PL_warnhook = (SV *) (SvREFCNT_inc_simple_NN(cv));
808 * The two SVs are magically freed by load_module
810 Perl_load_module(aTHX_ 0, pkgsv, NULL, layer, NULL);
813 return PerlIO_find_layer(aTHX_ name, len, 0);
816 PerlIO_debug("Cannot find %.*s\n", (int) len, name);
820 #ifdef USE_ATTRIBUTES_FOR_PERLIO
823 perlio_mg_set(pTHX_ SV *sv, MAGIC *mg)
826 IO * const io = GvIOn((GV *) SvRV(sv));
827 PerlIO * const ifp = IoIFP(io);
828 PerlIO * const ofp = IoOFP(io);
829 Perl_warn(aTHX_ "set %" SVf " %p %p %p",
830 SVfARG(sv), (void*)io, (void*)ifp, (void*)ofp);
836 perlio_mg_get(pTHX_ SV *sv, MAGIC *mg)
839 IO * const io = GvIOn((GV *) SvRV(sv));
840 PerlIO * const ifp = IoIFP(io);
841 PerlIO * const ofp = IoOFP(io);
842 Perl_warn(aTHX_ "get %" SVf " %p %p %p",
843 SVfARG(sv), (void*)io, (void*)ifp, (void*)ofp);
849 perlio_mg_clear(pTHX_ SV *sv, MAGIC *mg)
851 Perl_warn(aTHX_ "clear %" SVf, SVfARG(sv));
856 perlio_mg_free(pTHX_ SV *sv, MAGIC *mg)
858 Perl_warn(aTHX_ "free %" SVf, SVfARG(sv));
862 MGVTBL perlio_vtab = {
870 XS(XS_io_MODIFY_SCALAR_ATTRIBUTES)
873 SV * const sv = SvRV(ST(1));
874 AV * const av = newAV();
878 sv_magic(sv, (SV *) av, PERL_MAGIC_ext, NULL, 0);
880 mg = mg_find(sv, PERL_MAGIC_ext);
881 mg->mg_virtual = &perlio_vtab;
883 Perl_warn(aTHX_ "attrib %" SVf, SVfARG(sv));
884 for (i = 2; i < items; i++) {
886 const char * const name = SvPV_const(ST(i), len);
887 SV * const layer = PerlIO_find_layer(aTHX_ name, len, 1);
889 av_push(av, SvREFCNT_inc_simple_NN(layer));
900 #endif /* USE_ATTIBUTES_FOR_PERLIO */
903 PerlIO_tab_sv(pTHX_ PerlIO_funcs *tab)
905 HV * const stash = gv_stashpvs("PerlIO::Layer", GV_ADD);
906 SV * const sv = sv_bless(newRV_noinc(newSViv(PTR2IV(tab))), stash);
910 XS(XS_PerlIO__Layer__NoWarnings)
912 /* This is used as a %SIG{__WARN__} handler to supress warnings
913 during loading of layers.
918 PerlIO_debug("warning:%s\n",SvPV_nolen_const(ST(0)));
922 XS(XS_PerlIO__Layer__find)
927 Perl_croak(aTHX_ "Usage class->find(name[,load])");
930 const char * const name = SvPV_const(ST(1), len);
931 const bool load = (items > 2) ? SvTRUE(ST(2)) : 0;
932 PerlIO_funcs * const layer = PerlIO_find_layer(aTHX_ name, len, load);
934 (layer) ? sv_2mortal(PerlIO_tab_sv(aTHX_ layer)) :
941 PerlIO_define_layer(pTHX_ PerlIO_funcs *tab)
944 if (!PL_known_layers)
945 PL_known_layers = PerlIO_list_alloc(aTHX);
946 PerlIO_list_push(aTHX_ PL_known_layers, tab, NULL);
947 PerlIO_debug("define %s %p\n", tab->name, (void*)tab);
951 PerlIO_parse_layers(pTHX_ PerlIO_list_t *av, const char *names)
955 const char *s = names;
957 while (isSPACE(*s) || *s == ':')
962 const char *as = NULL;
964 if (!isIDFIRST(*s)) {
966 * Message is consistent with how attribute lists are
967 * passed. Even though this means "foo : : bar" is
968 * seen as an invalid separator character.
970 const char q = ((*s == '\'') ? '"' : '\'');
971 if (ckWARN(WARN_LAYER))
972 Perl_warner(aTHX_ packWARN(WARN_LAYER),
973 "Invalid separator character %c%c%c in PerlIO layer specification %s",
975 SETERRNO(EINVAL, LIB_INVARG);
980 } while (isALNUM(*e));
996 * It's a nul terminated string, not allowed
997 * to \ the terminating null. Anything other
998 * character is passed over.
1008 if (ckWARN(WARN_LAYER))
1009 Perl_warner(aTHX_ packWARN(WARN_LAYER),
1010 "Argument list not closed for PerlIO layer \"%.*s\"",
1022 PerlIO_funcs * const layer =
1023 PerlIO_find_layer(aTHX_ s, llen, 1);
1027 arg = newSVpvn(as, alen);
1028 PerlIO_list_push(aTHX_ av, layer,
1029 (arg) ? arg : &PL_sv_undef);
1034 if (ckWARN(WARN_LAYER))
1035 Perl_warner(aTHX_ packWARN(WARN_LAYER), "Unknown PerlIO layer \"%.*s\"",
1048 PerlIO_default_buffer(pTHX_ PerlIO_list_t *av)
1051 PERLIO_FUNCS_DECL(*tab) = &PerlIO_perlio;
1052 #ifdef PERLIO_USING_CRLF
1055 if (PerlIO_stdio.Set_ptrcnt)
1056 tab = &PerlIO_stdio;
1058 PerlIO_debug("Pushing %s\n", tab->name);
1059 PerlIO_list_push(aTHX_ av, PerlIO_find_layer(aTHX_ tab->name, 0, 0),
1064 PerlIO_arg_fetch(PerlIO_list_t *av, IV n)
1066 return av->array[n].arg;
1070 PerlIO_layer_fetch(pTHX_ PerlIO_list_t *av, IV n, PerlIO_funcs *def)
1072 if (n >= 0 && n < av->cur) {
1073 PerlIO_debug("Layer %" IVdf " is %s\n", n,
1074 av->array[n].funcs->name);
1075 return av->array[n].funcs;
1078 Perl_croak(aTHX_ "panic: PerlIO layer array corrupt");
1083 PerlIOPop_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1085 PERL_UNUSED_ARG(mode);
1086 PERL_UNUSED_ARG(arg);
1087 PERL_UNUSED_ARG(tab);
1088 if (PerlIOValid(f)) {
1090 PerlIO_pop(aTHX_ f);
1096 PERLIO_FUNCS_DECL(PerlIO_remove) = {
1097 sizeof(PerlIO_funcs),
1100 PERLIO_K_DUMMY | PERLIO_K_UTF8,
1120 NULL, /* get_base */
1121 NULL, /* get_bufsiz */
1124 NULL, /* set_ptrcnt */
1128 PerlIO_default_layers(pTHX)
1131 if (!PL_def_layerlist) {
1132 const char * const s = (PL_tainting) ? NULL : PerlEnv_getenv("PERLIO");
1133 PERLIO_FUNCS_DECL(*osLayer) = &PerlIO_unix;
1134 PL_def_layerlist = PerlIO_list_alloc(aTHX);
1135 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_unix));
1137 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_win32));
1139 osLayer = &PerlIO_win32;
1142 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_raw));
1143 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_perlio));
1144 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_stdio));
1145 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_crlf));
1147 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_mmap));
1149 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_utf8));
1150 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_remove));
1151 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_byte));
1152 PerlIO_list_push(aTHX_ PL_def_layerlist,
1153 PerlIO_find_layer(aTHX_ osLayer->name, 0, 0),
1156 PerlIO_parse_layers(aTHX_ PL_def_layerlist, s);
1159 PerlIO_default_buffer(aTHX_ PL_def_layerlist);
1162 if (PL_def_layerlist->cur < 2) {
1163 PerlIO_default_buffer(aTHX_ PL_def_layerlist);
1165 return PL_def_layerlist;
1169 Perl_boot_core_PerlIO(pTHX)
1171 #ifdef USE_ATTRIBUTES_FOR_PERLIO
1172 newXS("io::MODIFY_SCALAR_ATTRIBUTES", XS_io_MODIFY_SCALAR_ATTRIBUTES,
1175 newXS("PerlIO::Layer::find", XS_PerlIO__Layer__find, __FILE__);
1176 newXS("PerlIO::Layer::NoWarnings", XS_PerlIO__Layer__NoWarnings, __FILE__);
1180 PerlIO_default_layer(pTHX_ I32 n)
1183 PerlIO_list_t * const av = PerlIO_default_layers(aTHX);
1186 return PerlIO_layer_fetch(aTHX_ av, n, PERLIO_FUNCS_CAST(&PerlIO_stdio));
1189 #define PerlIO_default_top() PerlIO_default_layer(aTHX_ -1)
1190 #define PerlIO_default_btm() PerlIO_default_layer(aTHX_ 0)
1193 PerlIO_stdstreams(pTHX)
1197 PerlIO_allocate(aTHX);
1198 PerlIO_fdopen(0, "Ir" PERLIO_STDTEXT);
1199 PerlIO_fdopen(1, "Iw" PERLIO_STDTEXT);
1200 PerlIO_fdopen(2, "Iw" PERLIO_STDTEXT);
1205 PerlIO_push(pTHX_ PerlIO *f, PERLIO_FUNCS_DECL(*tab), const char *mode, SV *arg)
1207 if (tab->fsize != sizeof(PerlIO_funcs)) {
1209 Perl_croak(aTHX_ "Layer does not match this perl");
1213 if (tab->size < sizeof(PerlIOl)) {
1216 /* Real layer with a data area */
1219 Newxz(temp, tab->size, char);
1223 l->tab = (PerlIO_funcs*) tab;
1225 PerlIO_debug("PerlIO_push f=%p %s %s %p\n",
1226 (void*)f, tab->name,
1227 (mode) ? mode : "(Null)", (void*)arg);
1228 if (*l->tab->Pushed &&
1230 (aTHX_ f, mode, arg, (PerlIO_funcs*) tab) != 0) {
1231 PerlIO_pop(aTHX_ f);
1240 /* Pseudo-layer where push does its own stack adjust */
1241 PerlIO_debug("PerlIO_push f=%p %s %s %p\n", (void*)f, tab->name,
1242 (mode) ? mode : "(Null)", (void*)arg);
1244 (*tab->Pushed) (aTHX_ f, mode, arg, (PerlIO_funcs*) tab) != 0) {
1252 PerlIOBase_binmode(pTHX_ PerlIO *f)
1254 if (PerlIOValid(f)) {
1255 /* Is layer suitable for raw stream ? */
1256 if (PerlIOBase(f)->tab->kind & PERLIO_K_RAW) {
1257 /* Yes - turn off UTF-8-ness, to undo UTF-8 locale effects */
1258 PerlIOBase(f)->flags &= ~PERLIO_F_UTF8;
1261 /* Not suitable - pop it */
1262 PerlIO_pop(aTHX_ f);
1270 PerlIORaw_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1272 PERL_UNUSED_ARG(mode);
1273 PERL_UNUSED_ARG(arg);
1274 PERL_UNUSED_ARG(tab);
1276 if (PerlIOValid(f)) {
1281 * Strip all layers that are not suitable for a raw stream
1284 while (t && (l = *t)) {
1285 if (l->tab->Binmode) {
1286 /* Has a handler - normal case */
1287 if ((*l->tab->Binmode)(aTHX_ f) == 0) {
1289 /* Layer still there - move down a layer */
1298 /* No handler - pop it */
1299 PerlIO_pop(aTHX_ t);
1302 if (PerlIOValid(f)) {
1303 PerlIO_debug(":raw f=%p :%s\n", (void*)f, PerlIOBase(f)->tab->name);
1311 PerlIO_apply_layera(pTHX_ PerlIO *f, const char *mode,
1312 PerlIO_list_t *layers, IV n, IV max)
1316 PerlIO_funcs * const tab = PerlIO_layer_fetch(aTHX_ layers, n, NULL);
1318 if (!PerlIO_push(aTHX_ f, tab, mode, PerlIOArg)) {
1329 PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode, const char *names)
1333 PerlIO_list_t * const layers = PerlIO_list_alloc(aTHX);
1334 code = PerlIO_parse_layers(aTHX_ layers, names);
1336 code = PerlIO_apply_layera(aTHX_ f, mode, layers, 0, layers->cur);
1338 PerlIO_list_free(aTHX_ layers);
1344 /*--------------------------------------------------------------------------------------*/
1346 * Given the abstraction above the public API functions
1350 PerlIO_binmode(pTHX_ PerlIO *f, int iotype, int mode, const char *names)
1352 PerlIO_debug("PerlIO_binmode f=%p %s %c %x %s\n", (void*)f,
1353 (PerlIOBase(f)) ? PerlIOBase(f)->tab->name : "(Null)",
1354 iotype, mode, (names) ? names : "(Null)");
1357 /* Do not flush etc. if (e.g.) switching encodings.
1358 if a pushed layer knows it needs to flush lower layers
1359 (for example :unix which is never going to call them)
1360 it can do the flush when it is pushed.
1362 return PerlIO_apply_layers(aTHX_ f, NULL, names) == 0 ? TRUE : FALSE;
1365 /* Fake 5.6 legacy of using this call to turn ON O_TEXT */
1366 #ifdef PERLIO_USING_CRLF
1367 /* Legacy binmode only has meaning if O_TEXT has a value distinct from
1368 O_BINARY so we can look for it in mode.
1370 if (!(mode & O_BINARY)) {
1372 /* FIXME?: Looking down the layer stack seems wrong,
1373 but is a way of reaching past (say) an encoding layer
1374 to flip CRLF-ness of the layer(s) below
1377 /* Perhaps we should turn on bottom-most aware layer
1378 e.g. Ilya's idea that UNIX TTY could serve
1380 if (PerlIOBase(f)->tab->kind & PERLIO_K_CANCRLF) {
1381 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF)) {
1382 /* Not in text mode - flush any pending stuff and flip it */
1384 PerlIOBase(f)->flags |= PERLIO_F_CRLF;
1386 /* Only need to turn it on in one layer so we are done */
1391 /* Not finding a CRLF aware layer presumably means we are binary
1392 which is not what was requested - so we failed
1393 We _could_ push :crlf layer but so could caller
1398 /* Legacy binmode is now _defined_ as being equivalent to pushing :raw
1399 So code that used to be here is now in PerlIORaw_pushed().
1401 return PerlIO_push(aTHX_ f, PERLIO_FUNCS_CAST(&PerlIO_raw), NULL, NULL) ? TRUE : FALSE;
1406 PerlIO__close(pTHX_ PerlIO *f)
1408 if (PerlIOValid(f)) {
1409 PerlIO_funcs * const tab = PerlIOBase(f)->tab;
1410 if (tab && tab->Close)
1411 return (*tab->Close)(aTHX_ f);
1413 return PerlIOBase_close(aTHX_ f);
1416 SETERRNO(EBADF, SS_IVCHAN);
1422 Perl_PerlIO_close(pTHX_ PerlIO *f)
1424 const int code = PerlIO__close(aTHX_ f);
1425 while (PerlIOValid(f)) {
1426 PerlIO_pop(aTHX_ f);
1432 Perl_PerlIO_fileno(pTHX_ PerlIO *f)
1435 Perl_PerlIO_or_Base(f, Fileno, fileno, -1, (aTHX_ f));
1439 static PerlIO_funcs *
1440 PerlIO_layer_from_ref(pTHX_ SV *sv)
1444 * For any scalar type load the handler which is bundled with perl
1446 if (SvTYPE(sv) < SVt_PVAV) {
1447 PerlIO_funcs *f = PerlIO_find_layer(aTHX_ STR_WITH_LEN("scalar"), 1);
1448 /* This isn't supposed to happen, since PerlIO::scalar is core,
1449 * but could happen anyway in smaller installs or with PAR */
1450 if (!f && ckWARN(WARN_LAYER))
1451 Perl_warner(aTHX_ packWARN(WARN_LAYER), "Unknown PerlIO layer \"scalar\"");
1456 * For other types allow if layer is known but don't try and load it
1458 switch (SvTYPE(sv)) {
1460 return PerlIO_find_layer(aTHX_ STR_WITH_LEN("Array"), 0);
1462 return PerlIO_find_layer(aTHX_ STR_WITH_LEN("Hash"), 0);
1464 return PerlIO_find_layer(aTHX_ STR_WITH_LEN("Code"), 0);
1466 return PerlIO_find_layer(aTHX_ STR_WITH_LEN("Glob"), 0);
1473 PerlIO_resolve_layers(pTHX_ const char *layers,
1474 const char *mode, int narg, SV **args)
1477 PerlIO_list_t *def = PerlIO_default_layers(aTHX);
1480 PerlIO_stdstreams(aTHX);
1482 SV * const arg = *args;
1484 * If it is a reference but not an object see if we have a handler
1487 if (SvROK(arg) && !sv_isobject(arg)) {
1488 PerlIO_funcs * const handler = PerlIO_layer_from_ref(aTHX_ SvRV(arg));
1490 def = PerlIO_list_alloc(aTHX);
1491 PerlIO_list_push(aTHX_ def, handler, &PL_sv_undef);
1495 * Don't fail if handler cannot be found :via(...) etc. may do
1496 * something sensible else we will just stringfy and open
1501 if (!layers || !*layers)
1502 layers = Perl_PerlIO_context_layers(aTHX_ mode);
1503 if (layers && *layers) {
1506 av = PerlIO_clone_list(aTHX_ def, NULL);
1511 if (PerlIO_parse_layers(aTHX_ av, layers) == 0) {
1515 PerlIO_list_free(aTHX_ av);
1527 PerlIO_openn(pTHX_ const char *layers, const char *mode, int fd,
1528 int imode, int perm, PerlIO *f, int narg, SV **args)
1531 if (!f && narg == 1 && *args == &PL_sv_undef) {
1532 if ((f = PerlIO_tmpfile())) {
1533 if (!layers || !*layers)
1534 layers = Perl_PerlIO_context_layers(aTHX_ mode);
1535 if (layers && *layers)
1536 PerlIO_apply_layers(aTHX_ f, mode, layers);
1540 PerlIO_list_t *layera;
1542 PerlIO_funcs *tab = NULL;
1543 if (PerlIOValid(f)) {
1545 * This is "reopen" - it is not tested as perl does not use it
1549 layera = PerlIO_list_alloc(aTHX);
1553 arg = (*l->tab->Getarg) (aTHX_ &l, NULL, 0);
1554 PerlIO_list_push(aTHX_ layera, l->tab,
1555 (arg) ? arg : &PL_sv_undef);
1558 l = *PerlIONext(&l);
1562 layera = PerlIO_resolve_layers(aTHX_ layers, mode, narg, args);
1568 * Start at "top" of layer stack
1570 n = layera->cur - 1;
1572 PerlIO_funcs * const t = PerlIO_layer_fetch(aTHX_ layera, n, NULL);
1581 * Found that layer 'n' can do opens - call it
1583 if (narg > 1 && !(tab->kind & PERLIO_K_MULTIARG)) {
1584 Perl_croak(aTHX_ "More than one argument to open(,':%s')",tab->name);
1586 PerlIO_debug("openn(%s,'%s','%s',%d,%x,%o,%p,%d,%p)\n",
1587 tab->name, layers ? layers : "(Null)", mode, fd,
1588 imode, perm, (void*)f, narg, (void*)args);
1590 f = (*tab->Open) (aTHX_ tab, layera, n, mode, fd, imode, perm,
1593 SETERRNO(EINVAL, LIB_INVARG);
1597 if (n + 1 < layera->cur) {
1599 * More layers above the one that we used to open -
1602 if (PerlIO_apply_layera(aTHX_ f, mode, layera, n + 1, layera->cur) != 0) {
1603 /* If pushing layers fails close the file */
1610 PerlIO_list_free(aTHX_ layera);
1617 Perl_PerlIO_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
1619 Perl_PerlIO_or_Base(f, Read, read, -1, (aTHX_ f, vbuf, count));
1623 Perl_PerlIO_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
1625 Perl_PerlIO_or_Base(f, Unread, unread, -1, (aTHX_ f, vbuf, count));
1629 Perl_PerlIO_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
1631 Perl_PerlIO_or_fail(f, Write, -1, (aTHX_ f, vbuf, count));
1635 Perl_PerlIO_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
1637 Perl_PerlIO_or_fail(f, Seek, -1, (aTHX_ f, offset, whence));
1641 Perl_PerlIO_tell(pTHX_ PerlIO *f)
1643 Perl_PerlIO_or_fail(f, Tell, -1, (aTHX_ f));
1647 Perl_PerlIO_flush(pTHX_ PerlIO *f)
1652 const PerlIO_funcs *tab = PerlIOBase(f)->tab;
1654 if (tab && tab->Flush)
1655 return (*tab->Flush) (aTHX_ f);
1657 return 0; /* If no Flush defined, silently succeed. */
1660 PerlIO_debug("Cannot flush f=%p\n", (void*)f);
1661 SETERRNO(EBADF, SS_IVCHAN);
1667 * Is it good API design to do flush-all on NULL, a potentially
1668 * errorneous input? Maybe some magical value (PerlIO*
1669 * PERLIO_FLUSH_ALL = (PerlIO*)-1;)? Yes, stdio does similar
1670 * things on fflush(NULL), but should we be bound by their design
1673 PerlIO **table = &PL_perlio;
1675 while ((f = *table)) {
1677 table = (PerlIO **) (f++);
1678 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
1679 if (*f && PerlIO_flush(f) != 0)
1689 PerlIOBase_flush_linebuf(pTHX)
1692 PerlIO **table = &PL_perlio;
1694 while ((f = *table)) {
1696 table = (PerlIO **) (f++);
1697 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
1700 flags & (PERLIO_F_LINEBUF | PERLIO_F_CANWRITE))
1701 == (PERLIO_F_LINEBUF | PERLIO_F_CANWRITE))
1709 Perl_PerlIO_fill(pTHX_ PerlIO *f)
1711 Perl_PerlIO_or_fail(f, Fill, -1, (aTHX_ f));
1715 PerlIO_isutf8(PerlIO *f)
1718 return (PerlIOBase(f)->flags & PERLIO_F_UTF8) != 0;
1720 SETERRNO(EBADF, SS_IVCHAN);
1726 Perl_PerlIO_eof(pTHX_ PerlIO *f)
1728 Perl_PerlIO_or_Base(f, Eof, eof, -1, (aTHX_ f));
1732 Perl_PerlIO_error(pTHX_ PerlIO *f)
1734 Perl_PerlIO_or_Base(f, Error, error, -1, (aTHX_ f));
1738 Perl_PerlIO_clearerr(pTHX_ PerlIO *f)
1740 Perl_PerlIO_or_Base_void(f, Clearerr, clearerr, (aTHX_ f));
1744 Perl_PerlIO_setlinebuf(pTHX_ PerlIO *f)
1746 Perl_PerlIO_or_Base_void(f, Setlinebuf, setlinebuf, (aTHX_ f));
1750 PerlIO_has_base(PerlIO *f)
1752 if (PerlIOValid(f)) {
1753 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;
1756 return (tab->Get_base != NULL);
1757 SETERRNO(EINVAL, LIB_INVARG);
1760 SETERRNO(EBADF, SS_IVCHAN);
1766 PerlIO_fast_gets(PerlIO *f)
1768 if (PerlIOValid(f) && (PerlIOBase(f)->flags & PERLIO_F_FASTGETS)) {
1769 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;
1772 return (tab->Set_ptrcnt != NULL);
1773 SETERRNO(EINVAL, LIB_INVARG);
1776 SETERRNO(EBADF, SS_IVCHAN);
1782 PerlIO_has_cntptr(PerlIO *f)
1784 if (PerlIOValid(f)) {
1785 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;
1788 return (tab->Get_ptr != NULL && tab->Get_cnt != NULL);
1789 SETERRNO(EINVAL, LIB_INVARG);
1792 SETERRNO(EBADF, SS_IVCHAN);
1798 PerlIO_canset_cnt(PerlIO *f)
1800 if (PerlIOValid(f)) {
1801 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;
1804 return (tab->Set_ptrcnt != NULL);
1805 SETERRNO(EINVAL, LIB_INVARG);
1808 SETERRNO(EBADF, SS_IVCHAN);
1814 Perl_PerlIO_get_base(pTHX_ PerlIO *f)
1816 Perl_PerlIO_or_fail(f, Get_base, NULL, (aTHX_ f));
1820 Perl_PerlIO_get_bufsiz(pTHX_ PerlIO *f)
1822 Perl_PerlIO_or_fail(f, Get_bufsiz, -1, (aTHX_ f));
1826 Perl_PerlIO_get_ptr(pTHX_ PerlIO *f)
1828 Perl_PerlIO_or_fail(f, Get_ptr, NULL, (aTHX_ f));
1832 Perl_PerlIO_get_cnt(pTHX_ PerlIO *f)
1834 Perl_PerlIO_or_fail(f, Get_cnt, -1, (aTHX_ f));
1838 Perl_PerlIO_set_cnt(pTHX_ PerlIO *f, int cnt)
1840 Perl_PerlIO_or_fail_void(f, Set_ptrcnt, (aTHX_ f, NULL, cnt));
1844 Perl_PerlIO_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, int cnt)
1846 Perl_PerlIO_or_fail_void(f, Set_ptrcnt, (aTHX_ f, ptr, cnt));
1850 /*--------------------------------------------------------------------------------------*/
1852 * utf8 and raw dummy layers
1856 PerlIOUtf8_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1858 PERL_UNUSED_CONTEXT;
1859 PERL_UNUSED_ARG(mode);
1860 PERL_UNUSED_ARG(arg);
1861 if (PerlIOValid(f)) {
1862 if (tab->kind & PERLIO_K_UTF8)
1863 PerlIOBase(f)->flags |= PERLIO_F_UTF8;
1865 PerlIOBase(f)->flags &= ~PERLIO_F_UTF8;
1871 PERLIO_FUNCS_DECL(PerlIO_utf8) = {
1872 sizeof(PerlIO_funcs),
1875 PERLIO_K_DUMMY | PERLIO_K_UTF8,
1895 NULL, /* get_base */
1896 NULL, /* get_bufsiz */
1899 NULL, /* set_ptrcnt */
1902 PERLIO_FUNCS_DECL(PerlIO_byte) = {
1903 sizeof(PerlIO_funcs),
1926 NULL, /* get_base */
1927 NULL, /* get_bufsiz */
1930 NULL, /* set_ptrcnt */
1934 PerlIORaw_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
1935 IV n, const char *mode, int fd, int imode, int perm,
1936 PerlIO *old, int narg, SV **args)
1938 PerlIO_funcs * const tab = PerlIO_default_btm();
1939 PERL_UNUSED_ARG(self);
1940 if (tab && tab->Open)
1941 return (*tab->Open) (aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
1943 SETERRNO(EINVAL, LIB_INVARG);
1947 PERLIO_FUNCS_DECL(PerlIO_raw) = {
1948 sizeof(PerlIO_funcs),
1971 NULL, /* get_base */
1972 NULL, /* get_bufsiz */
1975 NULL, /* set_ptrcnt */
1977 /*--------------------------------------------------------------------------------------*/
1978 /*--------------------------------------------------------------------------------------*/
1980 * "Methods" of the "base class"
1984 PerlIOBase_fileno(pTHX_ PerlIO *f)
1986 return PerlIOValid(f) ? PerlIO_fileno(PerlIONext(f)) : -1;
1990 PerlIO_modestr(PerlIO * f, char *buf)
1993 if (PerlIOValid(f)) {
1994 const IV flags = PerlIOBase(f)->flags;
1995 if (flags & PERLIO_F_APPEND) {
1997 if (flags & PERLIO_F_CANREAD) {
2001 else if (flags & PERLIO_F_CANREAD) {
2003 if (flags & PERLIO_F_CANWRITE)
2006 else if (flags & PERLIO_F_CANWRITE) {
2008 if (flags & PERLIO_F_CANREAD) {
2012 #ifdef PERLIO_USING_CRLF
2013 if (!(flags & PERLIO_F_CRLF))
2023 PerlIOBase_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2025 PerlIOl * const l = PerlIOBase(f);
2026 PERL_UNUSED_CONTEXT;
2027 PERL_UNUSED_ARG(arg);
2029 l->flags &= ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE |
2030 PERLIO_F_TRUNCATE | PERLIO_F_APPEND);
2031 if (tab->Set_ptrcnt != NULL)
2032 l->flags |= PERLIO_F_FASTGETS;
2034 if (*mode == IoTYPE_NUMERIC || *mode == IoTYPE_IMPLICIT)
2038 l->flags |= PERLIO_F_CANREAD;
2041 l->flags |= PERLIO_F_APPEND | PERLIO_F_CANWRITE;
2044 l->flags |= PERLIO_F_TRUNCATE | PERLIO_F_CANWRITE;
2047 SETERRNO(EINVAL, LIB_INVARG);
2053 l->flags |= PERLIO_F_CANREAD | PERLIO_F_CANWRITE;
2056 l->flags &= ~PERLIO_F_CRLF;
2059 l->flags |= PERLIO_F_CRLF;
2062 SETERRNO(EINVAL, LIB_INVARG);
2069 l->flags |= l->next->flags &
2070 (PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_TRUNCATE |
2075 PerlIO_debug("PerlIOBase_pushed f=%p %s %s fl=%08" UVxf " (%s)\n",
2076 (void*)f, PerlIOBase(f)->tab->name, (omode) ? omode : "(Null)",
2077 l->flags, PerlIO_modestr(f, temp));
2083 PerlIOBase_popped(pTHX_ PerlIO *f)
2085 PERL_UNUSED_CONTEXT;
2091 PerlIOBase_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
2094 * Save the position as current head considers it
2096 const Off_t old = PerlIO_tell(f);
2097 PerlIO_push(aTHX_ f, PERLIO_FUNCS_CAST(&PerlIO_pending), "r", NULL);
2098 PerlIOSelf(f, PerlIOBuf)->posn = old;
2099 return PerlIOBuf_unread(aTHX_ f, vbuf, count);
2103 PerlIOBase_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
2105 STDCHAR *buf = (STDCHAR *) vbuf;
2107 if (!(PerlIOBase(f)->flags & PERLIO_F_CANREAD)) {
2108 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2109 SETERRNO(EBADF, SS_IVCHAN);
2115 SSize_t avail = PerlIO_get_cnt(f);
2118 take = ((SSize_t)count < avail) ? (SSize_t)count : avail;
2120 STDCHAR *ptr = PerlIO_get_ptr(f);
2121 Copy(ptr, buf, take, STDCHAR);
2122 PerlIO_set_ptrcnt(f, ptr + take, (avail -= take));
2125 if (avail == 0) /* set_ptrcnt could have reset avail */
2128 if (count > 0 && avail <= 0) {
2129 if (PerlIO_fill(f) != 0)
2134 return (buf - (STDCHAR *) vbuf);
2140 PerlIOBase_noop_ok(pTHX_ PerlIO *f)
2142 PERL_UNUSED_CONTEXT;
2148 PerlIOBase_noop_fail(pTHX_ PerlIO *f)
2150 PERL_UNUSED_CONTEXT;
2156 PerlIOBase_close(pTHX_ PerlIO *f)
2159 if (PerlIOValid(f)) {
2160 PerlIO *n = PerlIONext(f);
2161 code = PerlIO_flush(f);
2162 PerlIOBase(f)->flags &=
2163 ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_OPEN);
2164 while (PerlIOValid(n)) {
2165 const PerlIO_funcs * const tab = PerlIOBase(n)->tab;
2166 if (tab && tab->Close) {
2167 if ((*tab->Close)(aTHX_ n) != 0)
2172 PerlIOBase(n)->flags &=
2173 ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_OPEN);
2179 SETERRNO(EBADF, SS_IVCHAN);
2185 PerlIOBase_eof(pTHX_ PerlIO *f)
2187 PERL_UNUSED_CONTEXT;
2188 if (PerlIOValid(f)) {
2189 return (PerlIOBase(f)->flags & PERLIO_F_EOF) != 0;
2195 PerlIOBase_error(pTHX_ PerlIO *f)
2197 PERL_UNUSED_CONTEXT;
2198 if (PerlIOValid(f)) {
2199 return (PerlIOBase(f)->flags & PERLIO_F_ERROR) != 0;
2205 PerlIOBase_clearerr(pTHX_ PerlIO *f)
2207 if (PerlIOValid(f)) {
2208 PerlIO * const n = PerlIONext(f);
2209 PerlIOBase(f)->flags &= ~(PERLIO_F_ERROR | PERLIO_F_EOF);
2216 PerlIOBase_setlinebuf(pTHX_ PerlIO *f)
2218 PERL_UNUSED_CONTEXT;
2219 if (PerlIOValid(f)) {
2220 PerlIOBase(f)->flags |= PERLIO_F_LINEBUF;
2225 PerlIO_sv_dup(pTHX_ SV *arg, CLONE_PARAMS *param)
2231 arg = sv_dup(arg, param);
2232 SvREFCNT_inc_simple_void_NN(arg);
2236 return newSVsv(arg);
2239 PERL_UNUSED_ARG(param);
2240 return newSVsv(arg);
2245 PerlIOBase_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2247 PerlIO * const nexto = PerlIONext(o);
2248 if (PerlIOValid(nexto)) {
2249 const PerlIO_funcs * const tab = PerlIOBase(nexto)->tab;
2250 if (tab && tab->Dup)
2251 f = (*tab->Dup)(aTHX_ f, nexto, param, flags);
2253 f = PerlIOBase_dup(aTHX_ f, nexto, param, flags);
2256 PerlIO_funcs * const self = PerlIOBase(o)->tab;
2259 PerlIO_debug("PerlIOBase_dup %s f=%p o=%p param=%p\n",
2260 self->name, (void*)f, (void*)o, (void*)param);
2262 arg = (*self->Getarg)(aTHX_ o, param, flags);
2263 f = PerlIO_push(aTHX_ f, self, PerlIO_modestr(o,buf), arg);
2270 /* PL_perlio_fd_refcnt[] is in intrpvar.h */
2272 /* Must be called with PL_perlio_mutex locked. */
2274 S_more_refcounted_fds(pTHX_ const int new_fd) {
2276 const int old_max = PL_perlio_fd_refcnt_size;
2277 const int new_max = 16 + (new_fd & ~15);
2280 PerlIO_debug("More fds - old=%d, need %d, new=%d\n",
2281 old_max, new_fd, new_max);
2283 if (new_fd < old_max) {
2287 assert (new_max > new_fd);
2289 /* Use plain realloc() since we need this memory to be really
2290 * global and visible to all the interpreters and/or threads. */
2291 new_array = (int*) realloc(PL_perlio_fd_refcnt, new_max * sizeof(int));
2295 MUTEX_UNLOCK(&PL_perlio_mutex);
2297 /* Can't use PerlIO to write as it allocates memory */
2298 PerlLIO_write(PerlIO_fileno(Perl_error_log),
2299 PL_no_mem, strlen(PL_no_mem));
2303 PL_perlio_fd_refcnt_size = new_max;
2304 PL_perlio_fd_refcnt = new_array;
2306 PerlIO_debug("Zeroing %p, %d\n",
2307 (void*)(new_array + old_max),
2310 Zero(new_array + old_max, new_max - old_max, int);
2317 /* MUTEX_INIT(&PL_perlio_mutex) is done in PERL_SYS_INIT3(). */
2318 PERL_UNUSED_CONTEXT;
2322 PerlIOUnix_refcnt_inc(int fd)
2329 MUTEX_LOCK(&PL_perlio_mutex);
2331 if (fd >= PL_perlio_fd_refcnt_size)
2332 S_more_refcounted_fds(aTHX_ fd);
2334 PL_perlio_fd_refcnt[fd]++;
2335 if (PL_perlio_fd_refcnt[fd] <= 0) {
2336 Perl_croak(aTHX_ "refcnt_inc: fd %d: %d <= 0\n",
2337 fd, PL_perlio_fd_refcnt[fd]);
2339 PerlIO_debug("refcnt_inc: fd %d refcnt=%d\n",
2340 fd, PL_perlio_fd_refcnt[fd]);
2343 MUTEX_UNLOCK(&PL_perlio_mutex);
2346 Perl_croak(aTHX_ "refcnt_inc: fd %d < 0\n", fd);
2351 PerlIOUnix_refcnt_dec(int fd)
2358 MUTEX_LOCK(&PL_perlio_mutex);
2360 if (fd >= PL_perlio_fd_refcnt_size) {
2361 Perl_croak(aTHX_ "refcnt_dec: fd %d >= refcnt_size %d\n",
2362 fd, PL_perlio_fd_refcnt_size);
2364 if (PL_perlio_fd_refcnt[fd] <= 0) {
2365 Perl_croak(aTHX_ "refcnt_dec: fd %d: %d <= 0\n",
2366 fd, PL_perlio_fd_refcnt[fd]);
2368 cnt = --PL_perlio_fd_refcnt[fd];
2369 PerlIO_debug("refcnt_dec: fd %d refcnt=%d\n", fd, cnt);
2371 MUTEX_UNLOCK(&PL_perlio_mutex);
2374 Perl_croak(aTHX_ "refcnt_dec: fd %d < 0\n", fd);
2380 PerlIO_cleanup(pTHX)
2385 PerlIO_debug("Cleanup layers for %p\n",(void*)aTHX);
2387 PerlIO_debug("Cleanup layers\n");
2390 /* Raise STDIN..STDERR refcount so we don't close them */
2391 for (i=0; i < 3; i++)
2392 PerlIOUnix_refcnt_inc(i);
2393 PerlIO_cleantable(aTHX_ &PL_perlio);
2394 /* Restore STDIN..STDERR refcount */
2395 for (i=0; i < 3; i++)
2396 PerlIOUnix_refcnt_dec(i);
2398 if (PL_known_layers) {
2399 PerlIO_list_free(aTHX_ PL_known_layers);
2400 PL_known_layers = NULL;
2402 if (PL_def_layerlist) {
2403 PerlIO_list_free(aTHX_ PL_def_layerlist);
2404 PL_def_layerlist = NULL;
2408 void PerlIO_teardown(pTHX) /* Call only from PERL_SYS_TERM(). */
2413 /* By now all filehandles should have been closed, so any
2414 * stray (non-STD-)filehandles indicate *possible* (PerlIO)
2417 for (i = 3; i < PL_perlio_fd_refcnt_size; i++) {
2418 if (PL_perlio_fd_refcnt[i])
2419 PerlIO_debug("PerlIO_cleanup: fd %d refcnt=%d\n",
2420 i, PL_perlio_fd_refcnt[i]);
2424 /* Not bothering with PL_perlio_mutex since by now
2425 * all the interpreters are gone. */
2426 if (PL_perlio_fd_refcnt_size /* Assuming initial size of zero. */
2427 && PL_perlio_fd_refcnt) {
2428 free(PL_perlio_fd_refcnt); /* To match realloc() in S_more_refcounted_fds(). */
2429 PL_perlio_fd_refcnt = NULL;
2430 PL_perlio_fd_refcnt_size = 0;
2434 /*--------------------------------------------------------------------------------------*/
2436 * Bottom-most level for UNIX-like case
2440 struct _PerlIO base; /* The generic part */
2441 int fd; /* UNIX like file descriptor */
2442 int oflags; /* open/fcntl flags */
2446 PerlIOUnix_oflags(const char *mode)
2449 if (*mode == IoTYPE_IMPLICIT || *mode == IoTYPE_NUMERIC)
2454 if (*++mode == '+') {
2461 oflags = O_CREAT | O_TRUNC;
2462 if (*++mode == '+') {
2471 oflags = O_CREAT | O_APPEND;
2472 if (*++mode == '+') {
2485 else if (*mode == 't') {
2487 oflags &= ~O_BINARY;
2491 * Always open in binary mode
2494 if (*mode || oflags == -1) {
2495 SETERRNO(EINVAL, LIB_INVARG);
2502 PerlIOUnix_fileno(pTHX_ PerlIO *f)
2504 PERL_UNUSED_CONTEXT;
2505 return PerlIOSelf(f, PerlIOUnix)->fd;
2509 PerlIOUnix_setfd(pTHX_ PerlIO *f, int fd, int imode)
2511 PerlIOUnix * const s = PerlIOSelf(f, PerlIOUnix);
2514 if (PerlLIO_fstat(fd, &st) == 0) {
2515 if (!S_ISREG(st.st_mode)) {
2516 PerlIO_debug("%d is not regular file\n",fd);
2517 PerlIOBase(f)->flags |= PERLIO_F_NOTREG;
2520 PerlIO_debug("%d _is_ a regular file\n",fd);
2526 PerlIOUnix_refcnt_inc(fd);
2527 PERL_UNUSED_CONTEXT;
2531 PerlIOUnix_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2533 IV code = PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
2534 if (*PerlIONext(f)) {
2535 /* We never call down so do any pending stuff now */
2536 PerlIO_flush(PerlIONext(f));
2538 * XXX could (or should) we retrieve the oflags from the open file
2539 * handle rather than believing the "mode" we are passed in? XXX
2540 * Should the value on NULL mode be 0 or -1?
2542 PerlIOUnix_setfd(aTHX_ f, PerlIO_fileno(PerlIONext(f)),
2543 mode ? PerlIOUnix_oflags(mode) : -1);
2545 PerlIOBase(f)->flags |= PERLIO_F_OPEN;
2551 PerlIOUnix_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
2553 const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2555 PERL_UNUSED_CONTEXT;
2556 if (PerlIOBase(f)->flags & PERLIO_F_NOTREG) {
2558 SETERRNO(ESPIPE, LIB_INVARG);
2560 SETERRNO(EINVAL, LIB_INVARG);
2564 new_loc = PerlLIO_lseek(fd, offset, whence);
2565 if (new_loc == (Off_t) - 1)
2567 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
2572 PerlIOUnix_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
2573 IV n, const char *mode, int fd, int imode,
2574 int perm, PerlIO *f, int narg, SV **args)
2576 if (PerlIOValid(f)) {
2577 if (PerlIOBase(f)->flags & PERLIO_F_OPEN)
2578 (*PerlIOBase(f)->tab->Close)(aTHX_ f);
2581 if (*mode == IoTYPE_NUMERIC)
2584 imode = PerlIOUnix_oflags(mode);
2588 const char *path = SvPV_nolen_const(*args);
2589 fd = PerlLIO_open3(path, imode, perm);
2593 if (*mode == IoTYPE_IMPLICIT)
2596 f = PerlIO_allocate(aTHX);
2598 if (!PerlIOValid(f)) {
2599 if (!(f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg))) {
2603 PerlIOUnix_setfd(aTHX_ f, fd, imode);
2604 PerlIOBase(f)->flags |= PERLIO_F_OPEN;
2605 if (*mode == IoTYPE_APPEND)
2606 PerlIOUnix_seek(aTHX_ f, 0, SEEK_END);
2613 * FIXME: pop layers ???
2621 PerlIOUnix_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2623 const PerlIOUnix * const os = PerlIOSelf(o, PerlIOUnix);
2625 if (flags & PERLIO_DUP_FD) {
2626 fd = PerlLIO_dup(fd);
2629 f = PerlIOBase_dup(aTHX_ f, o, param, flags);
2631 /* If all went well overwrite fd in dup'ed lay with the dup()'ed fd */
2632 PerlIOUnix_setfd(aTHX_ f, fd, os->oflags);
2641 PerlIOUnix_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
2644 const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2645 #ifdef PERLIO_STD_SPECIAL
2647 return PERLIO_STD_IN(fd, vbuf, count);
2649 if (!(PerlIOBase(f)->flags & PERLIO_F_CANREAD) ||
2650 PerlIOBase(f)->flags & (PERLIO_F_EOF|PERLIO_F_ERROR)) {
2654 const SSize_t len = PerlLIO_read(fd, vbuf, count);
2655 if (len >= 0 || errno != EINTR) {
2657 if (errno != EAGAIN) {
2658 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2661 else if (len == 0 && count != 0) {
2662 PerlIOBase(f)->flags |= PERLIO_F_EOF;
2673 PerlIOUnix_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
2676 const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2677 #ifdef PERLIO_STD_SPECIAL
2678 if (fd == 1 || fd == 2)
2679 return PERLIO_STD_OUT(fd, vbuf, count);
2682 const SSize_t len = PerlLIO_write(fd, vbuf, count);
2683 if (len >= 0 || errno != EINTR) {
2685 if (errno != EAGAIN) {
2686 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2697 PerlIOUnix_tell(pTHX_ PerlIO *f)
2699 PERL_UNUSED_CONTEXT;
2701 return PerlLIO_lseek(PerlIOSelf(f, PerlIOUnix)->fd, 0, SEEK_CUR);
2706 PerlIOUnix_close(pTHX_ PerlIO *f)
2709 const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2711 if (PerlIOBase(f)->flags & PERLIO_F_OPEN) {
2712 if (PerlIOUnix_refcnt_dec(fd) > 0) {
2713 PerlIOBase(f)->flags &= ~PERLIO_F_OPEN;
2718 SETERRNO(EBADF,SS_IVCHAN);
2721 while (PerlLIO_close(fd) != 0) {
2722 if (errno != EINTR) {
2729 PerlIOBase(f)->flags &= ~PERLIO_F_OPEN;
2734 PERLIO_FUNCS_DECL(PerlIO_unix) = {
2735 sizeof(PerlIO_funcs),
2742 PerlIOBase_binmode, /* binmode */
2752 PerlIOBase_noop_ok, /* flush */
2753 PerlIOBase_noop_fail, /* fill */
2756 PerlIOBase_clearerr,
2757 PerlIOBase_setlinebuf,
2758 NULL, /* get_base */
2759 NULL, /* get_bufsiz */
2762 NULL, /* set_ptrcnt */
2765 /*--------------------------------------------------------------------------------------*/
2770 #if defined(VMS) && !defined(STDIO_BUFFER_WRITABLE)
2771 /* perl5.8 - This ensures the last minute VMS ungetc fix is not
2772 broken by the last second glibc 2.3 fix
2774 #define STDIO_BUFFER_WRITABLE
2779 struct _PerlIO base;
2780 FILE *stdio; /* The stream */
2784 PerlIOStdio_fileno(pTHX_ PerlIO *f)
2786 PERL_UNUSED_CONTEXT;
2788 if (PerlIOValid(f)) {
2789 FILE * const s = PerlIOSelf(f, PerlIOStdio)->stdio;
2791 return PerlSIO_fileno(s);
2798 PerlIOStdio_mode(const char *mode, char *tmode)
2800 char * const ret = tmode;
2806 #if defined(PERLIO_USING_CRLF) || defined(__CYGWIN__)
2814 PerlIOStdio_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2817 if (PerlIOValid(f) && PerlIOValid(n = PerlIONext(f))) {
2818 PerlIO_funcs * const toptab = PerlIOBase(n)->tab;
2819 if (toptab == tab) {
2820 /* Top is already stdio - pop self (duplicate) and use original */
2821 PerlIO_pop(aTHX_ f);
2824 const int fd = PerlIO_fileno(n);
2827 if (fd >= 0 && (stdio = PerlSIO_fdopen(fd,
2828 mode = PerlIOStdio_mode(mode, tmode)))) {
2829 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2830 /* We never call down so do any pending stuff now */
2831 PerlIO_flush(PerlIONext(f));
2838 return PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
2843 PerlIO_importFILE(FILE *stdio, const char *mode)
2849 if (!mode || !*mode) {
2850 /* We need to probe to see how we can open the stream
2851 so start with read/write and then try write and read
2852 we dup() so that we can fclose without loosing the fd.
2854 Note that the errno value set by a failing fdopen
2855 varies between stdio implementations.
2857 const int fd = PerlLIO_dup(fileno(stdio));
2858 FILE *f2 = PerlSIO_fdopen(fd, (mode = "r+"));
2860 f2 = PerlSIO_fdopen(fd, (mode = "w"));
2863 f2 = PerlSIO_fdopen(fd, (mode = "r"));
2866 /* Don't seem to be able to open */
2872 if ((f = PerlIO_push(aTHX_(f = PerlIO_allocate(aTHX)), PERLIO_FUNCS_CAST(&PerlIO_stdio), mode, NULL))) {
2873 s = PerlIOSelf(f, PerlIOStdio);
2881 PerlIOStdio_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
2882 IV n, const char *mode, int fd, int imode,
2883 int perm, PerlIO *f, int narg, SV **args)
2886 if (PerlIOValid(f)) {
2887 const char * const path = SvPV_nolen_const(*args);
2888 PerlIOStdio * const s = PerlIOSelf(f, PerlIOStdio);
2890 PerlIOUnix_refcnt_dec(fileno(s->stdio));
2891 stdio = PerlSIO_freopen(path, (mode = PerlIOStdio_mode(mode, tmode)),
2896 PerlIOUnix_refcnt_inc(fileno(s->stdio));
2901 const char * const path = SvPV_nolen_const(*args);
2902 if (*mode == IoTYPE_NUMERIC) {
2904 fd = PerlLIO_open3(path, imode, perm);
2908 bool appended = FALSE;
2910 /* Cygwin wants its 'b' early. */
2912 mode = PerlIOStdio_mode(mode, tmode);
2914 stdio = PerlSIO_fopen(path, mode);
2917 f = PerlIO_allocate(aTHX);
2920 mode = PerlIOStdio_mode(mode, tmode);
2921 f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg);
2923 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2924 PerlIOUnix_refcnt_inc(fileno(stdio));
2926 PerlSIO_fclose(stdio);
2938 if (*mode == IoTYPE_IMPLICIT) {
2945 stdio = PerlSIO_stdin;
2948 stdio = PerlSIO_stdout;
2951 stdio = PerlSIO_stderr;
2956 stdio = PerlSIO_fdopen(fd, mode =
2957 PerlIOStdio_mode(mode, tmode));
2961 f = PerlIO_allocate(aTHX);
2963 if ((f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg))) {
2964 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2965 PerlIOUnix_refcnt_inc(fileno(stdio));
2975 PerlIOStdio_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2977 /* This assumes no layers underneath - which is what
2978 happens, but is not how I remember it. NI-S 2001/10/16
2980 if ((f = PerlIOBase_dup(aTHX_ f, o, param, flags))) {
2981 FILE *stdio = PerlIOSelf(o, PerlIOStdio)->stdio;
2982 const int fd = fileno(stdio);
2984 if (flags & PERLIO_DUP_FD) {
2985 const int dfd = PerlLIO_dup(fileno(stdio));
2987 stdio = PerlSIO_fdopen(dfd, PerlIO_modestr(o,mode));
2992 /* FIXME: To avoid messy error recovery if dup fails
2993 re-use the existing stdio as though flag was not set
2997 stdio = PerlSIO_fdopen(fd, PerlIO_modestr(o,mode));
2999 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
3000 PerlIOUnix_refcnt_inc(fileno(stdio));
3006 PerlIOStdio_invalidate_fileno(pTHX_ FILE *f)
3008 PERL_UNUSED_CONTEXT;
3010 /* XXX this could use PerlIO_canset_fileno() and
3011 * PerlIO_set_fileno() support from Configure
3013 # if defined(__UCLIBC__)
3014 /* uClibc must come before glibc because it defines __GLIBC__ as well. */
3017 # elif defined(__GLIBC__)
3018 /* There may be a better way for GLIBC:
3019 - libio.h defines a flag to not close() on cleanup
3023 # elif defined(__sun__)
3026 # elif defined(__hpux)
3030 /* Next one ->_file seems to be a reasonable fallback, i.e. if
3031 your platform does not have special entry try this one.
3032 [For OSF only have confirmation for Tru64 (alpha)
3033 but assume other OSFs will be similar.]
3035 # elif defined(_AIX) || defined(__osf__) || defined(__irix__)
3038 # elif defined(__FreeBSD__)
3039 /* There may be a better way on FreeBSD:
3040 - we could insert a dummy func in the _close function entry
3041 f->_close = (int (*)(void *)) dummy_close;
3045 # elif defined(__OpenBSD__)
3046 /* There may be a better way on OpenBSD:
3047 - we could insert a dummy func in the _close function entry
3048 f->_close = (int (*)(void *)) dummy_close;
3052 # elif defined(__EMX__)
3053 /* f->_flags &= ~_IOOPEN; */ /* Will leak stream->_buffer */
3056 # elif defined(__CYGWIN__)
3057 /* There may be a better way on CYGWIN:
3058 - we could insert a dummy func in the _close function entry
3059 f->_close = (int (*)(void *)) dummy_close;
3063 # elif defined(WIN32)
3064 # if defined(__BORLANDC__)
3065 f->fd = PerlLIO_dup(fileno(f));
3066 # elif defined(UNDER_CE)
3067 /* WIN_CE does not have access to FILE internals, it hardly has FILE
3076 /* Sarathy's code did this - we fall back to a dup/dup2 hack
3077 (which isn't thread safe) instead
3079 # error "Don't know how to set FILE.fileno on your platform"
3087 PerlIOStdio_close(pTHX_ PerlIO *f)
3089 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3095 const int fd = fileno(stdio);
3100 #ifdef SOCKS5_VERSION_NAME
3101 /* Socks lib overrides close() but stdio isn't linked to
3102 that library (though we are) - so we must call close()
3103 on sockets on stdio's behalf.
3106 Sock_size_t optlen = sizeof(int);
3107 if (getsockopt(fd, SOL_SOCKET, SO_TYPE, (void *) &optval, &optlen) == 0)
3110 if (PerlIOUnix_refcnt_dec(fd) > 0) /* File descriptor still in use */
3113 /* For STD* handles, don't close stdio, since we shared the FILE *, too. */
3114 if (stdio == stdin) /* Some stdios are buggy fflush-ing inputs */
3116 if (stdio == stdout || stdio == stderr)
3117 return PerlIO_flush(f);
3118 /* Tricky - must fclose(stdio) to free memory but not close(fd)
3119 Use Sarathy's trick from maint-5.6 to invalidate the
3120 fileno slot of the FILE *
3122 result = PerlIO_flush(f);
3124 invalidate = PerlIOStdio_invalidate_fileno(aTHX_ stdio);
3126 dupfd = PerlLIO_dup(fd);
3128 result = PerlSIO_fclose(stdio);
3129 /* We treat error from stdio as success if we invalidated
3130 errno may NOT be expected EBADF
3132 if (invalidate && result != 0) {
3136 #ifdef SOCKS5_VERSION_NAME
3137 /* in SOCKS' case, let close() determine return value */
3141 PerlLIO_dup2(dupfd,fd);
3142 PerlLIO_close(dupfd);
3149 PerlIOStdio_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
3152 FILE * const s = PerlIOSelf(f, PerlIOStdio)->stdio;
3156 STDCHAR *buf = (STDCHAR *) vbuf;
3158 * Perl is expecting PerlIO_getc() to fill the buffer Linux's
3159 * stdio does not do that for fread()
3161 const int ch = PerlSIO_fgetc(s);
3168 got = PerlSIO_fread(vbuf, 1, count, s);
3169 if (got == 0 && PerlSIO_ferror(s))
3171 if (got >= 0 || errno != EINTR)
3174 SETERRNO(0,0); /* just in case */
3180 PerlIOStdio_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3183 FILE * const s = PerlIOSelf(f, PerlIOStdio)->stdio;
3185 #ifdef STDIO_BUFFER_WRITABLE
3186 if (PerlIO_fast_gets(f) && PerlIO_has_base(f)) {
3187 STDCHAR *buf = ((STDCHAR *) vbuf) + count;
3188 STDCHAR *base = PerlIO_get_base(f);
3189 SSize_t cnt = PerlIO_get_cnt(f);
3190 STDCHAR *ptr = PerlIO_get_ptr(f);
3191 SSize_t avail = ptr - base;
3193 if (avail > count) {
3197 Move(buf-avail,ptr,avail,STDCHAR);
3200 PerlIO_set_ptrcnt(f,ptr,cnt+avail);
3201 if (PerlSIO_feof(s) && unread >= 0)
3202 PerlSIO_clearerr(s);
3207 if (PerlIO_has_cntptr(f)) {
3208 /* We can get pointer to buffer but not its base
3209 Do ungetc() but check chars are ending up in the
3212 STDCHAR *eptr = (STDCHAR*)PerlSIO_get_ptr(s);
3213 STDCHAR *buf = ((STDCHAR *) vbuf) + count;
3215 const int ch = *--buf & 0xFF;
3216 if (ungetc(ch,s) != ch) {
3217 /* ungetc did not work */
3220 if ((STDCHAR*)PerlSIO_get_ptr(s) != --eptr || ((*eptr & 0xFF) != ch)) {
3221 /* Did not change pointer as expected */
3222 fgetc(s); /* get char back again */
3232 unread += PerlIOBase_unread(aTHX_ f, vbuf, count);
3238 PerlIOStdio_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3243 got = PerlSIO_fwrite(vbuf, 1, count,
3244 PerlIOSelf(f, PerlIOStdio)->stdio);
3245 if (got >= 0 || errno != EINTR)
3248 SETERRNO(0,0); /* just in case */
3254 PerlIOStdio_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3256 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3257 PERL_UNUSED_CONTEXT;
3259 return PerlSIO_fseek(stdio, offset, whence);
3263 PerlIOStdio_tell(pTHX_ PerlIO *f)
3265 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3266 PERL_UNUSED_CONTEXT;
3268 return PerlSIO_ftell(stdio);
3272 PerlIOStdio_flush(pTHX_ PerlIO *f)
3274 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3275 PERL_UNUSED_CONTEXT;
3277 if (PerlIOBase(f)->flags & PERLIO_F_CANWRITE) {
3278 return PerlSIO_fflush(stdio);
3284 * FIXME: This discards ungetc() and pre-read stuff which is not
3285 * right if this is just a "sync" from a layer above Suspect right
3286 * design is to do _this_ but not have layer above flush this
3287 * layer read-to-read
3290 * Not writeable - sync by attempting a seek
3292 const int err = errno;
3293 if (PerlSIO_fseek(stdio, (Off_t) 0, SEEK_CUR) != 0)
3301 PerlIOStdio_eof(pTHX_ PerlIO *f)
3303 PERL_UNUSED_CONTEXT;
3305 return PerlSIO_feof(PerlIOSelf(f, PerlIOStdio)->stdio);
3309 PerlIOStdio_error(pTHX_ PerlIO *f)
3311 PERL_UNUSED_CONTEXT;
3313 return PerlSIO_ferror(PerlIOSelf(f, PerlIOStdio)->stdio);
3317 PerlIOStdio_clearerr(pTHX_ PerlIO *f)
3319 PERL_UNUSED_CONTEXT;
3321 PerlSIO_clearerr(PerlIOSelf(f, PerlIOStdio)->stdio);
3325 PerlIOStdio_setlinebuf(pTHX_ PerlIO *f)
3327 PERL_UNUSED_CONTEXT;
3329 #ifdef HAS_SETLINEBUF
3330 PerlSIO_setlinebuf(PerlIOSelf(f, PerlIOStdio)->stdio);
3332 PerlSIO_setvbuf(PerlIOSelf(f, PerlIOStdio)->stdio, NULL, _IOLBF, 0);
3338 PerlIOStdio_get_base(pTHX_ PerlIO *f)
3340 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3341 return (STDCHAR*)PerlSIO_get_base(stdio);
3345 PerlIOStdio_get_bufsiz(pTHX_ PerlIO *f)
3347 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3348 return PerlSIO_get_bufsiz(stdio);
3352 #ifdef USE_STDIO_PTR
3354 PerlIOStdio_get_ptr(pTHX_ PerlIO *f)
3356 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3357 return (STDCHAR*)PerlSIO_get_ptr(stdio);
3361 PerlIOStdio_get_cnt(pTHX_ PerlIO *f)
3363 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3364 return PerlSIO_get_cnt(stdio);
3368 PerlIOStdio_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
3370 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3372 #ifdef STDIO_PTR_LVALUE
3373 PerlSIO_set_ptr(stdio, ptr); /* LHS STDCHAR* cast non-portable */
3374 #ifdef STDIO_PTR_LVAL_SETS_CNT
3375 if (PerlSIO_get_cnt(stdio) != (cnt)) {
3376 assert(PerlSIO_get_cnt(stdio) == (cnt));
3379 #if (!defined(STDIO_PTR_LVAL_NOCHANGE_CNT))
3381 * Setting ptr _does_ change cnt - we are done
3385 #else /* STDIO_PTR_LVALUE */
3387 #endif /* STDIO_PTR_LVALUE */
3390 * Now (or only) set cnt
3392 #ifdef STDIO_CNT_LVALUE
3393 PerlSIO_set_cnt(stdio, cnt);
3394 #else /* STDIO_CNT_LVALUE */
3395 #if (defined(STDIO_PTR_LVALUE) && defined(STDIO_PTR_LVAL_SETS_CNT))
3396 PerlSIO_set_ptr(stdio,
3397 PerlSIO_get_ptr(stdio) + (PerlSIO_get_cnt(stdio) -
3399 #else /* STDIO_PTR_LVAL_SETS_CNT */
3401 #endif /* STDIO_PTR_LVAL_SETS_CNT */
3402 #endif /* STDIO_CNT_LVALUE */
3409 PerlIOStdio_fill(pTHX_ PerlIO *f)
3411 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3413 PERL_UNUSED_CONTEXT;
3416 * fflush()ing read-only streams can cause trouble on some stdio-s
3418 if ((PerlIOBase(f)->flags & PERLIO_F_CANWRITE)) {
3419 if (PerlSIO_fflush(stdio) != 0)
3423 c = PerlSIO_fgetc(stdio);
3426 if (! PerlSIO_ferror(stdio) || errno != EINTR)
3432 #if (defined(STDIO_PTR_LVALUE) && (defined(STDIO_CNT_LVALUE) || defined(STDIO_PTR_LVAL_SETS_CNT)))
3434 #ifdef STDIO_BUFFER_WRITABLE
3435 if (PerlIO_fast_gets(f) && PerlIO_has_base(f)) {
3436 /* Fake ungetc() to the real buffer in case system's ungetc
3439 STDCHAR *base = (STDCHAR*)PerlSIO_get_base(stdio);
3440 SSize_t cnt = PerlSIO_get_cnt(stdio);
3441 STDCHAR *ptr = (STDCHAR*)PerlSIO_get_ptr(stdio);
3442 if (ptr == base+1) {
3443 *--ptr = (STDCHAR) c;
3444 PerlIOStdio_set_ptrcnt(aTHX_ f,ptr,cnt+1);
3445 if (PerlSIO_feof(stdio))
3446 PerlSIO_clearerr(stdio);
3452 if (PerlIO_has_cntptr(f)) {
3454 if (PerlIOStdio_unread(aTHX_ f,&ch,1) == 1) {
3461 /* An ungetc()d char is handled separately from the regular
3462 * buffer, so we stuff it in the buffer ourselves.
3463 * Should never get called as should hit code above
3465 *(--((*stdio)->_ptr)) = (unsigned char) c;
3468 /* If buffer snoop scheme above fails fall back to
3471 if (PerlSIO_ungetc(c, stdio) != c)
3479 PERLIO_FUNCS_DECL(PerlIO_stdio) = {
3480 sizeof(PerlIO_funcs),
3482 sizeof(PerlIOStdio),
3483 PERLIO_K_BUFFERED|PERLIO_K_RAW,
3487 PerlIOBase_binmode, /* binmode */
3501 PerlIOStdio_clearerr,
3502 PerlIOStdio_setlinebuf,
3504 PerlIOStdio_get_base,
3505 PerlIOStdio_get_bufsiz,
3510 #ifdef USE_STDIO_PTR
3511 PerlIOStdio_get_ptr,
3512 PerlIOStdio_get_cnt,
3513 # if defined(HAS_FAST_STDIO) && defined(USE_FAST_STDIO)
3514 PerlIOStdio_set_ptrcnt,
3517 # endif /* HAS_FAST_STDIO && USE_FAST_STDIO */
3522 #endif /* USE_STDIO_PTR */
3525 /* Note that calls to PerlIO_exportFILE() are reversed using
3526 * PerlIO_releaseFILE(), not importFILE. */
3528 PerlIO_exportFILE(PerlIO * f, const char *mode)
3532 if (PerlIOValid(f)) {
3535 if (!mode || !*mode) {
3536 mode = PerlIO_modestr(f, buf);
3538 stdio = PerlSIO_fdopen(PerlIO_fileno(f), mode);
3542 /* De-link any lower layers so new :stdio sticks */
3544 if ((f2 = PerlIO_push(aTHX_ f, PERLIO_FUNCS_CAST(&PerlIO_stdio), buf, NULL))) {
3545 PerlIOStdio *s = PerlIOSelf((f = f2), PerlIOStdio);
3547 /* Link previous lower layers under new one */
3551 /* restore layers list */
3561 PerlIO_findFILE(PerlIO *f)
3565 if (l->tab == &PerlIO_stdio) {
3566 PerlIOStdio *s = PerlIOSelf(&l, PerlIOStdio);
3569 l = *PerlIONext(&l);
3571 /* Uses fallback "mode" via PerlIO_modestr() in PerlIO_exportFILE */
3572 return PerlIO_exportFILE(f, NULL);
3575 /* Use this to reverse PerlIO_exportFILE calls. */
3577 PerlIO_releaseFILE(PerlIO *p, FILE *f)
3582 if (l->tab == &PerlIO_stdio) {
3583 PerlIOStdio *s = PerlIOSelf(&l, PerlIOStdio);
3584 if (s->stdio == f) {
3586 PerlIO_pop(aTHX_ p);
3595 /*--------------------------------------------------------------------------------------*/
3597 * perlio buffer layer
3601 PerlIOBuf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
3603 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3604 const int fd = PerlIO_fileno(f);
3605 if (fd >= 0 && PerlLIO_isatty(fd)) {
3606 PerlIOBase(f)->flags |= PERLIO_F_LINEBUF | PERLIO_F_TTY;
3608 if (*PerlIONext(f)) {
3609 const Off_t posn = PerlIO_tell(PerlIONext(f));
3610 if (posn != (Off_t) - 1) {
3614 return PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
3618 PerlIOBuf_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
3619 IV n, const char *mode, int fd, int imode, int perm,
3620 PerlIO *f, int narg, SV **args)
3622 if (PerlIOValid(f)) {
3623 PerlIO *next = PerlIONext(f);
3625 PerlIO_layer_fetch(aTHX_ layers, n - 1, PerlIOBase(next)->tab);
3626 if (tab && tab->Open)
3628 (*tab->Open)(aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
3630 if (!next || (*PerlIOBase(f)->tab->Pushed) (aTHX_ f, mode, PerlIOArg, self) != 0) {
3635 PerlIO_funcs *tab = PerlIO_layer_fetch(aTHX_ layers, n - 1, PerlIO_default_btm());
3637 if (*mode == IoTYPE_IMPLICIT) {
3643 if (tab && tab->Open)
3644 f = (*tab->Open)(aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
3647 SETERRNO(EINVAL, LIB_INVARG);
3649 if (PerlIO_push(aTHX_ f, self, mode, PerlIOArg) == 0) {
3651 * if push fails during open, open fails. close will pop us.
3656 fd = PerlIO_fileno(f);
3657 if (init && fd == 2) {
3659 * Initial stderr is unbuffered
3661 PerlIOBase(f)->flags |= PERLIO_F_UNBUF;
3663 #ifdef PERLIO_USING_CRLF
3664 # ifdef PERLIO_IS_BINMODE_FD
3665 if (PERLIO_IS_BINMODE_FD(fd))
3666 PerlIO_binmode(aTHX_ f, '<'/*not used*/, O_BINARY, NULL);
3670 * do something about failing setmode()? --jhi
3672 PerlLIO_setmode(fd, O_BINARY);
3681 * This "flush" is akin to sfio's sync in that it handles files in either
3682 * read or write state. For write state, we put the postponed data through
3683 * the next layers. For read state, we seek() the next layers to the
3684 * offset given by current position in the buffer, and discard the buffer
3685 * state (XXXX supposed to be for seek()able buffers only, but now it is done
3686 * in any case?). Then the pass the stick further in chain.
3689 PerlIOBuf_flush(pTHX_ PerlIO *f)
3691 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3693 PerlIO *n = PerlIONext(f);
3694 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF) {
3696 * write() the buffer
3698 const STDCHAR *buf = b->buf;
3699 const STDCHAR *p = buf;
3700 while (p < b->ptr) {
3701 SSize_t count = PerlIO_write(n, p, b->ptr - p);
3705 else if (count < 0 || PerlIO_error(n)) {
3706 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
3711 b->posn += (p - buf);
3713 else if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3714 STDCHAR *buf = PerlIO_get_base(f);
3716 * Note position change
3718 b->posn += (b->ptr - buf);
3719 if (b->ptr < b->end) {
3720 /* We did not consume all of it - try and seek downstream to
3721 our logical position
3723 if (PerlIOValid(n) && PerlIO_seek(n, b->posn, SEEK_SET) == 0) {
3724 /* Reload n as some layers may pop themselves on seek */
3725 b->posn = PerlIO_tell(n = PerlIONext(f));
3728 /* Seek failed (e.g. pipe or tty). Do NOT clear buffer or pre-read
3729 data is lost for good - so return saying "ok" having undone
3732 b->posn -= (b->ptr - buf);
3737 b->ptr = b->end = b->buf;
3738 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3739 /* We check for Valid because of dubious decision to make PerlIO_flush(NULL) flush all */
3740 if (PerlIOValid(n) && PerlIO_flush(n) != 0)
3745 /* This discards the content of the buffer after b->ptr, and rereads
3746 * the buffer from the position off in the layer downstream; here off
3747 * is at offset corresponding to b->ptr - b->buf.
3750 PerlIOBuf_fill(pTHX_ PerlIO *f)
3752 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3753 PerlIO *n = PerlIONext(f);
3756 * Down-stream flush is defined not to loose read data so is harmless.
3757 * we would not normally be fill'ing if there was data left in anycase.
3759 if (PerlIO_flush(f) != 0) /* XXXX Check that its seek() succeeded?! */
3761 if (PerlIOBase(f)->flags & PERLIO_F_TTY)
3762 PerlIOBase_flush_linebuf(aTHX);
3765 PerlIO_get_base(f); /* allocate via vtable */
3767 assert(b->buf); /* The b->buf does get allocated via the vtable system. */
3769 b->ptr = b->end = b->buf;
3771 if (!PerlIOValid(n)) {
3772 PerlIOBase(f)->flags |= PERLIO_F_EOF;
3776 if (PerlIO_fast_gets(n)) {
3778 * Layer below is also buffered. We do _NOT_ want to call its
3779 * ->Read() because that will loop till it gets what we asked for
3780 * which may hang on a pipe etc. Instead take anything it has to
3781 * hand, or ask it to fill _once_.
3783 avail = PerlIO_get_cnt(n);
3785 avail = PerlIO_fill(n);
3787 avail = PerlIO_get_cnt(n);
3789 if (!PerlIO_error(n) && PerlIO_eof(n))
3794 STDCHAR *ptr = PerlIO_get_ptr(n);
3795 const SSize_t cnt = avail;
3796 if (avail > (SSize_t)b->bufsiz)
3798 Copy(ptr, b->buf, avail, STDCHAR);
3799 PerlIO_set_ptrcnt(n, ptr + avail, cnt - avail);
3803 avail = PerlIO_read(n, b->ptr, b->bufsiz);
3807 PerlIOBase(f)->flags |= PERLIO_F_EOF;
3809 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
3812 b->end = b->buf + avail;
3813 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3818 PerlIOBuf_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
3820 if (PerlIOValid(f)) {
3821 const PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3824 return PerlIOBase_read(aTHX_ f, vbuf, count);
3830 PerlIOBuf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3832 const STDCHAR *buf = (const STDCHAR *) vbuf + count;
3833 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3836 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
3841 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3843 * Buffer is already a read buffer, we can overwrite any chars
3844 * which have been read back to buffer start
3846 avail = (b->ptr - b->buf);
3850 * Buffer is idle, set it up so whole buffer is available for
3854 b->end = b->buf + avail;
3856 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3858 * Buffer extends _back_ from where we are now
3860 b->posn -= b->bufsiz;
3862 if (avail > (SSize_t) count) {
3864 * If we have space for more than count, just move count
3872 * In simple stdio-like ungetc() case chars will be already
3875 if (buf != b->ptr) {
3876 Copy(buf, b->ptr, avail, STDCHAR);
3880 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
3884 unread += PerlIOBase_unread(aTHX_ f, vbuf, count);
3890 PerlIOBuf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3892 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3893 const STDCHAR *buf = (const STDCHAR *) vbuf;
3894 const STDCHAR *flushptr = buf;
3898 if (!(PerlIOBase(f)->flags & PERLIO_F_CANWRITE))
3900 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3901 if (PerlIO_flush(f) != 0) {
3905 if (PerlIOBase(f)->flags & PERLIO_F_LINEBUF) {
3906 flushptr = buf + count;
3907 while (flushptr > buf && *(flushptr - 1) != '\n')
3911 SSize_t avail = b->bufsiz - (b->ptr - b->buf);
3912 if ((SSize_t) count < avail)
3914 if (flushptr > buf && flushptr <= buf + avail)
3915 avail = flushptr - buf;
3916 PerlIOBase(f)->flags |= PERLIO_F_WRBUF;
3918 Copy(buf, b->ptr, avail, STDCHAR);
3923 if (buf == flushptr)
3926 if (b->ptr >= (b->buf + b->bufsiz))
3929 if (PerlIOBase(f)->flags & PERLIO_F_UNBUF)
3935 PerlIOBuf_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3938 if ((code = PerlIO_flush(f)) == 0) {
3939 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
3940 code = PerlIO_seek(PerlIONext(f), offset, whence);
3942 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3943 b->posn = PerlIO_tell(PerlIONext(f));
3950 PerlIOBuf_tell(pTHX_ PerlIO *f)
3952 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3954 * b->posn is file position where b->buf was read, or will be written
3956 Off_t posn = b->posn;
3957 if ((PerlIOBase(f)->flags & PERLIO_F_APPEND) &&
3958 (PerlIOBase(f)->flags & PERLIO_F_WRBUF)) {
3960 /* As O_APPEND files are normally shared in some sense it is better
3965 /* when file is NOT shared then this is sufficient */
3966 PerlIO_seek(PerlIONext(f),0, SEEK_END);
3968 posn = b->posn = PerlIO_tell(PerlIONext(f));
3972 * If buffer is valid adjust position by amount in buffer
3974 posn += (b->ptr - b->buf);
3980 PerlIOBuf_popped(pTHX_ PerlIO *f)
3982 const IV code = PerlIOBase_popped(aTHX_ f);
3983 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3984 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
3987 b->ptr = b->end = b->buf = NULL;
3988 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3993 PerlIOBuf_close(pTHX_ PerlIO *f)
3995 const IV code = PerlIOBase_close(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_get_ptr(pTHX_ PerlIO *f)
4008 const PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4015 PerlIOBuf_get_cnt(pTHX_ PerlIO *f)
4017 const PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4020 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF)
4021 return (b->end - b->ptr);
4026 PerlIOBuf_get_base(pTHX_ PerlIO *f)
4028 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4029 PERL_UNUSED_CONTEXT;
4034 b->buf = Newxz(b->buf,b->bufsiz, STDCHAR);
4036 b->buf = (STDCHAR *) & b->oneword;
4037 b->bufsiz = sizeof(b->oneword);
4039 b->end = b->ptr = b->buf;
4045 PerlIOBuf_bufsiz(pTHX_ PerlIO *f)
4047 const PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4050 return (b->end - b->buf);
4054 PerlIOBuf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
4056 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4060 if (PerlIO_get_cnt(f) != cnt || b->ptr < b->buf) {
4061 assert(PerlIO_get_cnt(f) == cnt);
4062 assert(b->ptr >= b->buf);
4064 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4068 PerlIOBuf_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
4070 return PerlIOBase_dup(aTHX_ f, o, param, flags);
4075 PERLIO_FUNCS_DECL(PerlIO_perlio) = {
4076 sizeof(PerlIO_funcs),
4079 PERLIO_K_BUFFERED|PERLIO_K_RAW,
4083 PerlIOBase_binmode, /* binmode */
4097 PerlIOBase_clearerr,
4098 PerlIOBase_setlinebuf,
4103 PerlIOBuf_set_ptrcnt,
4106 /*--------------------------------------------------------------------------------------*/
4108 * Temp layer to hold unread chars when cannot do it any other way
4112 PerlIOPending_fill(pTHX_ PerlIO *f)
4115 * Should never happen
4122 PerlIOPending_close(pTHX_ PerlIO *f)
4125 * A tad tricky - flush pops us, then we close new top
4128 return PerlIO_close(f);
4132 PerlIOPending_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
4135 * A tad tricky - flush pops us, then we seek new top
4138 return PerlIO_seek(f, offset, whence);
4143 PerlIOPending_flush(pTHX_ PerlIO *f)
4145 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4146 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
4150 PerlIO_pop(aTHX_ f);
4155 PerlIOPending_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
4161 PerlIOBuf_set_ptrcnt(aTHX_ f, ptr, cnt);
4166 PerlIOPending_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
4168 const IV code = PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
4169 PerlIOl * const l = PerlIOBase(f);
4171 * Our PerlIO_fast_gets must match what we are pushed on, or sv_gets()
4172 * etc. get muddled when it changes mid-string when we auto-pop.
4174 l->flags = (l->flags & ~(PERLIO_F_FASTGETS | PERLIO_F_UTF8)) |
4175 (PerlIOBase(PerlIONext(f))->
4176 flags & (PERLIO_F_FASTGETS | PERLIO_F_UTF8));
4181 PerlIOPending_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
4183 SSize_t avail = PerlIO_get_cnt(f);
4185 if ((SSize_t)count < avail)
4188 got = PerlIOBuf_read(aTHX_ f, vbuf, avail);
4189 if (got >= 0 && got < (SSize_t)count) {
4190 const SSize_t more =
4191 PerlIO_read(f, ((STDCHAR *) vbuf) + got, count - got);
4192 if (more >= 0 || got == 0)
4198 PERLIO_FUNCS_DECL(PerlIO_pending) = {
4199 sizeof(PerlIO_funcs),
4202 PERLIO_K_BUFFERED|PERLIO_K_RAW, /* not sure about RAW here */
4203 PerlIOPending_pushed,
4206 PerlIOBase_binmode, /* binmode */
4215 PerlIOPending_close,
4216 PerlIOPending_flush,
4220 PerlIOBase_clearerr,
4221 PerlIOBase_setlinebuf,
4226 PerlIOPending_set_ptrcnt,
4231 /*--------------------------------------------------------------------------------------*/
4233 * crlf - translation On read translate CR,LF to "\n" we do this by
4234 * overriding ptr/cnt entries to hand back a line at a time and keeping a
4235 * record of which nl we "lied" about. On write translate "\n" to CR,LF
4237 * c->nl points on the first byte of CR LF pair when it is temporarily
4238 * replaced by LF, or to the last CR of the buffer. In the former case
4239 * the caller thinks that the buffer ends at c->nl + 1, in the latter
4240 * that it ends at c->nl; these two cases can be distinguished by
4241 * *c->nl. c->nl is set during _getcnt() call, and unset during
4242 * _unread() and _flush() calls.
4243 * It only matters for read operations.
4247 PerlIOBuf base; /* PerlIOBuf stuff */
4248 STDCHAR *nl; /* Position of crlf we "lied" about in the
4252 /* Inherit the PERLIO_F_UTF8 flag from previous layer.
4253 * Otherwise the :crlf layer would always revert back to
4257 S_inherit_utf8_flag(PerlIO *f)
4259 PerlIO *g = PerlIONext(f);
4260 if (PerlIOValid(g)) {
4261 if (PerlIOBase(g)->flags & PERLIO_F_UTF8) {
4262 PerlIOBase(f)->flags |= PERLIO_F_UTF8;
4268 PerlIOCrlf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
4271 PerlIOBase(f)->flags |= PERLIO_F_CRLF;
4272 code = PerlIOBuf_pushed(aTHX_ f, mode, arg, tab);
4274 PerlIO_debug("PerlIOCrlf_pushed f=%p %s %s fl=%08" UVxf "\n",
4275 (void*)f, PerlIOBase(f)->tab->name, (mode) ? mode : "(Null)",
4276 PerlIOBase(f)->flags);
4279 /* Enable the first CRLF capable layer you can find, but if none
4280 * found, the one we just pushed is fine. This results in at
4281 * any given moment at most one CRLF-capable layer being enabled
4282 * in the whole layer stack. */
4283 PerlIO *g = PerlIONext(f);
4284 while (PerlIOValid(g)) {
4285 PerlIOl *b = PerlIOBase(g);
4286 if (b && b->tab == &PerlIO_crlf) {
4287 if (!(b->flags & PERLIO_F_CRLF))
4288 b->flags |= PERLIO_F_CRLF;
4289 S_inherit_utf8_flag(g);
4290 PerlIO_pop(aTHX_ f);
4296 S_inherit_utf8_flag(f);
4302 PerlIOCrlf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4304 PerlIOCrlf * const c = PerlIOSelf(f, PerlIOCrlf);
4305 if (c->nl) { /* XXXX Shouldn't it be done only if b->ptr > c->nl? */
4309 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF))
4310 return PerlIOBuf_unread(aTHX_ f, vbuf, count);
4312 const STDCHAR *buf = (const STDCHAR *) vbuf + count;
4313 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4315 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
4320 if (!(PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4321 b->end = b->ptr = b->buf + b->bufsiz;
4322 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4323 b->posn -= b->bufsiz;
4325 while (count > 0 && b->ptr > b->buf) {
4326 const int ch = *--buf;
4328 if (b->ptr - 2 >= b->buf) {
4335 /* If b->ptr - 1 == b->buf, we are undoing reading 0xa */
4336 *--(b->ptr) = 0xa; /* Works even if 0xa == '\r' */
4352 /* XXXX This code assumes that buffer size >=2, but does not check it... */
4354 PerlIOCrlf_get_cnt(pTHX_ PerlIO *f)
4356 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4359 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
4360 PerlIOCrlf * const c = PerlIOSelf(f, PerlIOCrlf);
4361 if ((PerlIOBase(f)->flags & PERLIO_F_CRLF) && (!c->nl || *c->nl == 0xd)) {
4362 STDCHAR *nl = (c->nl) ? c->nl : b->ptr;
4364 while (nl < b->end && *nl != 0xd)
4366 if (nl < b->end && *nl == 0xd) {
4368 if (nl + 1 < b->end) {
4375 * Not CR,LF but just CR
4383 * Blast - found CR as last char in buffer
4388 * They may not care, defer work as long as
4392 return (nl - b->ptr);
4396 b->ptr++; /* say we have read it as far as
4397 * flush() is concerned */
4398 b->buf++; /* Leave space in front of buffer */
4399 /* Note as we have moved buf up flush's
4401 will naturally make posn point at CR
4403 b->bufsiz--; /* Buffer is thus smaller */
4404 code = PerlIO_fill(f); /* Fetch some more */
4405 b->bufsiz++; /* Restore size for next time */
4406 b->buf--; /* Point at space */
4407 b->ptr = nl = b->buf; /* Which is what we hand
4409 *nl = 0xd; /* Fill in the CR */
4411 goto test; /* fill() call worked */
4413 * CR at EOF - just fall through
4415 /* Should we clear EOF though ??? */
4420 return (((c->nl) ? (c->nl + 1) : b->end) - b->ptr);
4426 PerlIOCrlf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
4428 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4429 PerlIOCrlf * const c = PerlIOSelf(f, PerlIOCrlf);
4435 if (ptr == b->end && *c->nl == 0xd) {
4436 /* Defered CR at end of buffer case - we lied about count */
4449 * Test code - delete when it works ...
4451 IV flags = PerlIOBase(f)->flags;
4452 STDCHAR *chk = (c->nl) ? (c->nl+1) : b->end;
4453 if (ptr+cnt == c->nl && c->nl+1 == b->end && *c->nl == 0xd) {
4454 /* Defered CR at end of buffer case - we lied about count */
4460 Perl_croak(aTHX_ "ptr wrong %p != %p fl=%08" UVxf
4461 " nl=%p e=%p for %d", (void*)ptr, (void*)chk,
4462 flags, c->nl, b->end, cnt);
4469 * They have taken what we lied about
4477 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4481 PerlIOCrlf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4483 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF))
4484 return PerlIOBuf_write(aTHX_ f, vbuf, count);
4486 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4487 const STDCHAR *buf = (const STDCHAR *) vbuf;
4488 const STDCHAR * const ebuf = buf + count;
4491 if (!(PerlIOBase(f)->flags & PERLIO_F_CANWRITE))
4493 while (buf < ebuf) {
4494 const STDCHAR * const eptr = b->buf + b->bufsiz;
4495 PerlIOBase(f)->flags |= PERLIO_F_WRBUF;
4496 while (buf < ebuf && b->ptr < eptr) {
4498 if ((b->ptr + 2) > eptr) {
4506 *(b->ptr)++ = 0xd; /* CR */
4507 *(b->ptr)++ = 0xa; /* LF */
4509 if (PerlIOBase(f)->flags & PERLIO_F_LINEBUF) {
4516 *(b->ptr)++ = *buf++;
4518 if (b->ptr >= eptr) {
4524 if (PerlIOBase(f)->flags & PERLIO_F_UNBUF)
4526 return (buf - (STDCHAR *) vbuf);
4531 PerlIOCrlf_flush(pTHX_ PerlIO *f)
4533 PerlIOCrlf * const c = PerlIOSelf(f, PerlIOCrlf);
4538 return PerlIOBuf_flush(aTHX_ f);
4542 PerlIOCrlf_binmode(pTHX_ PerlIO *f)
4544 if ((PerlIOBase(f)->flags & PERLIO_F_CRLF)) {
4545 /* In text mode - flush any pending stuff and flip it */
4546 PerlIOBase(f)->flags &= ~PERLIO_F_CRLF;
4547 #ifndef PERLIO_USING_CRLF
4548 /* CRLF is unusual case - if this is just the :crlf layer pop it */
4549 if (PerlIOBase(f)->tab == &PerlIO_crlf) {
4550 PerlIO_pop(aTHX_ f);
4557 PERLIO_FUNCS_DECL(PerlIO_crlf) = {
4558 sizeof(PerlIO_funcs),
4561 PERLIO_K_BUFFERED | PERLIO_K_CANCRLF | PERLIO_K_RAW,
4563 PerlIOBuf_popped, /* popped */
4565 PerlIOCrlf_binmode, /* binmode */
4569 PerlIOBuf_read, /* generic read works with ptr/cnt lies */
4570 PerlIOCrlf_unread, /* Put CR,LF in buffer for each '\n' */
4571 PerlIOCrlf_write, /* Put CR,LF in buffer for each '\n' */
4579 PerlIOBase_clearerr,
4580 PerlIOBase_setlinebuf,
4585 PerlIOCrlf_set_ptrcnt,
4589 /*--------------------------------------------------------------------------------------*/
4591 * mmap as "buffer" layer
4595 PerlIOBuf base; /* PerlIOBuf stuff */
4596 Mmap_t mptr; /* Mapped address */
4597 Size_t len; /* mapped length */
4598 STDCHAR *bbuf; /* malloced buffer if map fails */
4602 PerlIOMmap_map(pTHX_ PerlIO *f)
4605 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4606 const IV flags = PerlIOBase(f)->flags;
4610 if (flags & PERLIO_F_CANREAD) {
4611 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4612 const int fd = PerlIO_fileno(f);
4614 code = Fstat(fd, &st);
4615 if (code == 0 && S_ISREG(st.st_mode)) {
4616 SSize_t len = st.st_size - b->posn;
4619 if (PL_mmap_page_size <= 0)
4620 Perl_croak(aTHX_ "panic: bad pagesize %" IVdf,
4624 * This is a hack - should never happen - open should
4627 b->posn = PerlIO_tell(PerlIONext(f));
4629 posn = (b->posn / PL_mmap_page_size) * PL_mmap_page_size;
4630 len = st.st_size - posn;
4631 m->mptr = (Mmap_t)mmap(NULL, len, PROT_READ, MAP_SHARED, fd, posn);
4632 if (m->mptr && m->mptr != (Mmap_t) - 1) {
4633 #if 0 && defined(HAS_MADVISE) && defined(MADV_SEQUENTIAL)
4634 madvise(m->mptr, len, MADV_SEQUENTIAL);
4636 #if 0 && defined(HAS_MADVISE) && defined(MADV_WILLNEED)
4637 madvise(m->mptr, len, MADV_WILLNEED);
4639 PerlIOBase(f)->flags =
4640 (flags & ~PERLIO_F_EOF) | PERLIO_F_RDBUF;
4641 b->end = ((STDCHAR *) m->mptr) + len;
4642 b->buf = ((STDCHAR *) m->mptr) + (b->posn - posn);
4651 PerlIOBase(f)->flags =
4652 flags | PERLIO_F_EOF | PERLIO_F_RDBUF;
4654 b->ptr = b->end = b->ptr;
4663 PerlIOMmap_unmap(pTHX_ PerlIO *f)
4665 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4668 PerlIOBuf * const b = &m->base;
4670 /* The munmap address argument is tricky: depending on the
4671 * standard it is either "void *" or "caddr_t" (which is
4672 * usually "char *" (signed or unsigned). If we cast it
4673 * to "void *", those that have it caddr_t and an uptight
4674 * C++ compiler, will freak out. But casting it as char*
4675 * should work. Maybe. (Using Mmap_t figured out by
4676 * Configure doesn't always work, apparently.) */
4677 code = munmap((char*)m->mptr, m->len);
4681 if (PerlIO_seek(PerlIONext(f), b->posn, SEEK_SET) != 0)
4684 b->ptr = b->end = b->buf;
4685 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
4691 PerlIOMmap_get_base(pTHX_ PerlIO *f)
4693 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4694 PerlIOBuf * const b = &m->base;
4695 if (b->buf && (PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4697 * Already have a readbuffer in progress
4703 * We have a write buffer or flushed PerlIOBuf read buffer
4705 m->bbuf = b->buf; /* save it in case we need it again */
4706 b->buf = NULL; /* Clear to trigger below */
4709 PerlIOMmap_map(aTHX_ f); /* Try and map it */
4712 * Map did not work - recover PerlIOBuf buffer if we have one
4717 b->ptr = b->end = b->buf;
4720 return PerlIOBuf_get_base(aTHX_ f);
4724 PerlIOMmap_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4726 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4727 PerlIOBuf * const b = &m->base;
4728 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
4730 if (b->ptr && (b->ptr - count) >= b->buf
4731 && memEQ(b->ptr - count, vbuf, count)) {
4733 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
4738 * Loose the unwritable mapped buffer
4742 * If flush took the "buffer" see if we have one from before
4744 if (!b->buf && m->bbuf)
4747 PerlIOBuf_get_base(aTHX_ f);
4751 return PerlIOBuf_unread(aTHX_ f, vbuf, count);
4755 PerlIOMmap_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4757 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4758 PerlIOBuf * const b = &m->base;
4760 if (!b->buf || !(PerlIOBase(f)->flags & PERLIO_F_WRBUF)) {
4762 * No, or wrong sort of, buffer
4765 if (PerlIOMmap_unmap(aTHX_ f) != 0)
4769 * If unmap took the "buffer" see if we have one from before
4771 if (!b->buf && m->bbuf)
4774 PerlIOBuf_get_base(aTHX_ f);
4778 return PerlIOBuf_write(aTHX_ f, vbuf, count);
4782 PerlIOMmap_flush(pTHX_ PerlIO *f)
4784 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4785 PerlIOBuf * const b = &m->base;
4786 IV code = PerlIOBuf_flush(aTHX_ f);
4788 * Now we are "synced" at PerlIOBuf level
4795 if (PerlIOMmap_unmap(aTHX_ f) != 0)
4800 * We seem to have a PerlIOBuf buffer which was not mapped
4801 * remember it in case we need one later
4810 PerlIOMmap_fill(pTHX_ PerlIO *f)
4812 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4813 IV code = PerlIO_flush(f);
4814 if (code == 0 && !b->buf) {
4815 code = PerlIOMmap_map(aTHX_ f);
4817 if (code == 0 && !(PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4818 code = PerlIOBuf_fill(aTHX_ f);
4824 PerlIOMmap_close(pTHX_ PerlIO *f)
4826 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4827 PerlIOBuf * const b = &m->base;
4828 IV code = PerlIO_flush(f);
4832 b->ptr = b->end = b->buf;
4834 if (PerlIOBuf_close(aTHX_ f) != 0)
4840 PerlIOMmap_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
4842 return PerlIOBase_dup(aTHX_ f, o, param, flags);
4846 PERLIO_FUNCS_DECL(PerlIO_mmap) = {
4847 sizeof(PerlIO_funcs),
4850 PERLIO_K_BUFFERED|PERLIO_K_RAW,
4854 PerlIOBase_binmode, /* binmode */
4868 PerlIOBase_clearerr,
4869 PerlIOBase_setlinebuf,
4870 PerlIOMmap_get_base,
4874 PerlIOBuf_set_ptrcnt,
4877 #endif /* HAS_MMAP */
4880 Perl_PerlIO_stdin(pTHX)
4884 PerlIO_stdstreams(aTHX);
4886 return &PL_perlio[1];
4890 Perl_PerlIO_stdout(pTHX)
4894 PerlIO_stdstreams(aTHX);
4896 return &PL_perlio[2];
4900 Perl_PerlIO_stderr(pTHX)
4904 PerlIO_stdstreams(aTHX);
4906 return &PL_perlio[3];
4909 /*--------------------------------------------------------------------------------------*/
4912 PerlIO_getname(PerlIO *f, char *buf)
4917 bool exported = FALSE;
4918 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
4920 stdio = PerlIO_exportFILE(f,0);
4924 name = fgetname(stdio, buf);
4925 if (exported) PerlIO_releaseFILE(f,stdio);
4930 PERL_UNUSED_ARG(buf);
4931 Perl_croak(aTHX_ "Don't know how to get file name");
4937 /*--------------------------------------------------------------------------------------*/
4939 * Functions which can be called on any kind of PerlIO implemented in
4943 #undef PerlIO_fdopen
4945 PerlIO_fdopen(int fd, const char *mode)
4948 return PerlIO_openn(aTHX_ NULL, mode, fd, 0, 0, NULL, 0, NULL);
4953 PerlIO_open(const char *path, const char *mode)
4956 SV *name = sv_2mortal(newSVpv(path, 0));
4957 return PerlIO_openn(aTHX_ NULL, mode, -1, 0, 0, NULL, 1, &name);
4960 #undef Perlio_reopen
4962 PerlIO_reopen(const char *path, const char *mode, PerlIO *f)
4965 SV *name = sv_2mortal(newSVpv(path,0));
4966 return PerlIO_openn(aTHX_ NULL, mode, -1, 0, 0, f, 1, &name);
4971 PerlIO_getc(PerlIO *f)
4975 if ( 1 == PerlIO_read(f, buf, 1) ) {
4976 return (unsigned char) buf[0];
4981 #undef PerlIO_ungetc
4983 PerlIO_ungetc(PerlIO *f, int ch)
4988 if (PerlIO_unread(f, &buf, 1) == 1)
4996 PerlIO_putc(PerlIO *f, int ch)
5000 return PerlIO_write(f, &buf, 1);
5005 PerlIO_puts(PerlIO *f, const char *s)
5008 return PerlIO_write(f, s, strlen(s));
5011 #undef PerlIO_rewind
5013 PerlIO_rewind(PerlIO *f)
5016 PerlIO_seek(f, (Off_t) 0, SEEK_SET);
5020 #undef PerlIO_vprintf
5022 PerlIO_vprintf(PerlIO *f, const char *fmt, va_list ap)
5025 SV * const sv = newSVpvs("");
5031 Perl_va_copy(ap, apc);
5032 sv_vcatpvf(sv, fmt, &apc);
5034 sv_vcatpvf(sv, fmt, &ap);
5036 s = SvPV_const(sv, len);
5037 wrote = PerlIO_write(f, s, len);
5042 #undef PerlIO_printf
5044 PerlIO_printf(PerlIO *f, const char *fmt, ...)
5049 result = PerlIO_vprintf(f, fmt, ap);
5054 #undef PerlIO_stdoutf
5056 PerlIO_stdoutf(const char *fmt, ...)
5062 result = PerlIO_vprintf(PerlIO_stdout(), fmt, ap);
5067 #undef PerlIO_tmpfile
5069 PerlIO_tmpfile(void)
5074 const int fd = win32_tmpfd();
5076 f = PerlIO_fdopen(fd, "w+b");
5078 # if defined(HAS_MKSTEMP) && ! defined(VMS) && ! defined(OS2)
5079 SV * const sv = newSVpvs("/tmp/PerlIO_XXXXXX");
5081 * I have no idea how portable mkstemp() is ... NI-S
5083 const int fd = mkstemp(SvPVX(sv));
5085 f = PerlIO_fdopen(fd, "w+");
5087 PerlIOBase(f)->flags |= PERLIO_F_TEMP;
5088 PerlLIO_unlink(SvPVX_const(sv));
5091 # else /* !HAS_MKSTEMP, fallback to stdio tmpfile(). */
5092 FILE * const stdio = PerlSIO_tmpfile();
5095 f = PerlIO_fdopen(fileno(stdio), "w+");
5097 # endif /* else HAS_MKSTEMP */
5098 #endif /* else WIN32 */
5105 #endif /* USE_SFIO */
5106 #endif /* PERLIO_IS_STDIO */
5108 /*======================================================================================*/
5110 * Now some functions in terms of above which may be needed even if we are
5111 * not in true PerlIO mode
5114 Perl_PerlIO_context_layers(pTHX_ const char *mode)
5117 const char *direction = NULL;
5120 * Need to supply default layer info from open.pm
5126 if (mode && mode[0] != 'r') {
5127 if (PL_curcop->cop_hints & HINT_LEXICAL_IO_OUT)
5128 direction = "open>";
5130 if (PL_curcop->cop_hints & HINT_LEXICAL_IO_IN)
5131 direction = "open<";
5136 layers = Perl_refcounted_he_fetch(aTHX_ PL_curcop->cop_hints_hash,
5137 0, direction, 5, 0, 0);
5140 return SvOK(layers) ? SvPV_nolen_const(layers) : NULL;
5145 #undef PerlIO_setpos
5147 PerlIO_setpos(PerlIO *f, SV *pos)
5152 const Off_t * const posn = (Off_t *) SvPV(pos, len);
5153 if (f && len == sizeof(Off_t))
5154 return PerlIO_seek(f, *posn, SEEK_SET);
5156 SETERRNO(EINVAL, SS_IVCHAN);
5160 #undef PerlIO_setpos
5162 PerlIO_setpos(PerlIO *f, SV *pos)
5167 Fpos_t * const fpos = (Fpos_t *) SvPV(pos, len);
5168 if (f && len == sizeof(Fpos_t)) {
5169 #if defined(USE_64_BIT_STDIO) && defined(USE_FSETPOS64)
5170 return fsetpos64(f, fpos);
5172 return fsetpos(f, fpos);
5176 SETERRNO(EINVAL, SS_IVCHAN);
5182 #undef PerlIO_getpos
5184 PerlIO_getpos(PerlIO *f, SV *pos)
5187 Off_t posn = PerlIO_tell(f);
5188 sv_setpvn(pos, (char *) &posn, sizeof(posn));
5189 return (posn == (Off_t) - 1) ? -1 : 0;
5192 #undef PerlIO_getpos
5194 PerlIO_getpos(PerlIO *f, SV *pos)
5199 #if defined(USE_64_BIT_STDIO) && defined(USE_FSETPOS64)
5200 code = fgetpos64(f, &fpos);
5202 code = fgetpos(f, &fpos);
5204 sv_setpvn(pos, (char *) &fpos, sizeof(fpos));
5209 #if (defined(PERLIO_IS_STDIO) || !defined(USE_SFIO)) && !defined(HAS_VPRINTF)
5212 vprintf(char *pat, char *args)
5214 _doprnt(pat, args, stdout);
5215 return 0; /* wrong, but perl doesn't use the return
5220 vfprintf(FILE *fd, char *pat, char *args)
5222 _doprnt(pat, args, fd);
5223 return 0; /* wrong, but perl doesn't use the return
5229 #ifndef PerlIO_vsprintf
5231 PerlIO_vsprintf(char *s, int n, const char *fmt, va_list ap)
5234 const int val = my_vsnprintf(s, n > 0 ? n : 0, fmt, ap);
5235 PERL_UNUSED_CONTEXT;
5237 #ifndef PERL_MY_VSNPRINTF_GUARDED
5238 if (val < 0 || (n > 0 ? val >= n : 0)) {
5239 Perl_croak(aTHX_ "panic: my_vsnprintf overflow in PerlIO_vsprintf\n");
5246 #ifndef PerlIO_sprintf
5248 PerlIO_sprintf(char *s, int n, const char *fmt, ...)
5253 result = PerlIO_vsprintf(s, n, fmt, ap);
5261 * c-indentation-style: bsd
5263 * indent-tabs-mode: t
5266 * ex: set ts=8 sts=4 sw=4 noet: