3 * Copyright (c) 1996-2006, Nick Ing-Simmons
4 * Copyright (c) 2006, 2007, 2008, 2009, 2010, 2011 Larry Wall and others
6 * You may distribute under the terms of either the GNU General Public License
7 * or the Artistic License, as specified in the README file.
11 * Hour after hour for nearly three weary days he had jogged up and down,
12 * over passes, and through long dales, and across many streams.
14 * [pp.791-792 of _The Lord of the Rings_, V/iii: "The Muster of Rohan"]
17 /* This file contains the functions needed to implement PerlIO, which
18 * is Perl's private replacement for the C stdio library. This is used
19 * by default unless you compile with -Uuseperlio or run with
20 * PERLIO=:stdio (but don't do this unless you know what you're doing)
24 * If we have ActivePerl-like PERL_IMPLICIT_SYS then we need a dTHX to get
25 * at the dispatch tables, even when we do not need it for other reasons.
26 * Invent a dSYS macro to abstract this out
28 #ifdef PERL_IMPLICIT_SYS
34 #define PERLIO_NOT_STDIO 0
36 * This file provides those parts of PerlIO abstraction
37 * which are not #defined in perlio.h.
38 * Which these are depends on various Configure #ifdef's
42 #define PERL_IN_PERLIO_C
45 #ifdef PERL_IMPLICIT_CONTEXT
56 #define PerlIO_lockcnt(f) (((PerlIOl*)(f))->head->flags)
58 /* Call the callback or PerlIOBase, and return failure. */
59 #define Perl_PerlIO_or_Base(f, callback, base, failure, args) \
60 if (PerlIOValid(f)) { \
61 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;\
62 if (tab && tab->callback) \
63 return (*tab->callback) args; \
65 return PerlIOBase_ ## base args; \
68 SETERRNO(EBADF, SS_IVCHAN); \
71 /* Call the callback or fail, and return failure. */
72 #define Perl_PerlIO_or_fail(f, callback, 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; \
77 SETERRNO(EINVAL, LIB_INVARG); \
80 SETERRNO(EBADF, SS_IVCHAN); \
83 /* Call the callback or PerlIOBase, and be void. */
84 #define Perl_PerlIO_or_Base_void(f, callback, base, args) \
85 if (PerlIOValid(f)) { \
86 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;\
87 if (tab && tab->callback) \
88 (*tab->callback) args; \
90 PerlIOBase_ ## base args; \
93 SETERRNO(EBADF, SS_IVCHAN)
95 /* Call the callback or fail, and be void. */
96 #define Perl_PerlIO_or_fail_void(f, callback, args) \
97 if (PerlIOValid(f)) { \
98 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;\
99 if (tab && tab->callback) \
100 (*tab->callback) args; \
102 SETERRNO(EINVAL, LIB_INVARG); \
105 SETERRNO(EBADF, SS_IVCHAN)
107 #if defined(__osf__) && _XOPEN_SOURCE < 500
108 extern int fseeko(FILE *, off_t, int);
109 extern off_t ftello(FILE *);
112 #define NATIVE_0xd CR_NATIVE
113 #define NATIVE_0xa LF_NATIVE
115 EXTERN_C int perlsio_binmode(FILE *fp, int iotype, int mode);
118 perlsio_binmode(FILE *fp, int iotype, int mode)
121 * This used to be contents of do_binmode in doio.c
125 PERL_UNUSED_ARG(iotype);
127 if (PerlLIO_setmode(fp, mode) != -1) {
129 if (PerlLIO_setmode(fileno(fp), mode) != -1) {
136 # if defined(USEMYBINMODE)
138 # if defined(__CYGWIN__)
139 PERL_UNUSED_ARG(iotype);
141 if (my_binmode(fp, iotype, mode) != FALSE)
147 PERL_UNUSED_ARG(iotype);
148 PERL_UNUSED_ARG(mode);
155 #define O_ACCMODE 3 /* Assume traditional implementation */
159 PerlIO_intmode2str(int rawmode, char *mode, int *writing)
161 const int result = rawmode & O_ACCMODE;
166 ptype = IoTYPE_RDONLY;
169 ptype = IoTYPE_WRONLY;
177 *writing = (result != O_RDONLY);
179 if (result == O_RDONLY) {
183 else if (rawmode & O_APPEND) {
185 if (result != O_WRONLY)
190 if (result == O_WRONLY)
198 /* Unless O_BINARY is different from zero, bit-and:ing
199 * with it won't do much good. */
200 if (rawmode & O_BINARY)
207 #ifndef PERLIO_LAYERS
209 PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode, const char *names)
211 if (!names || !*names
212 || strEQ(names, ":crlf")
213 || strEQ(names, ":raw")
214 || strEQ(names, ":bytes")
218 Perl_croak(aTHX_ "Cannot apply \"%s\" in non-PerlIO perl", names);
226 PerlIO_destruct(pTHX)
231 PerlIO_binmode(pTHX_ PerlIO *fp, int iotype, int mode, const char *names)
233 return perlsio_binmode(fp, iotype, mode);
237 PerlIO_fdupopen(pTHX_ PerlIO *f, CLONE_PARAMS *param, int flags)
239 #if defined(PERL_MICRO)
241 #elif defined(PERL_IMPLICIT_SYS)
242 return PerlSIO_fdupopen(f);
245 return win32_fdupopen(f);
248 const int fd = PerlLIO_dup_cloexec(PerlIO_fileno(f));
252 const int omode = djgpp_get_stream_mode(f);
254 const int omode = fcntl(fd, F_GETFL);
256 PerlIO_intmode2str(omode,mode,NULL);
257 /* the r+ is a hack */
258 return PerlIO_fdopen(fd, mode);
263 SETERRNO(EBADF, SS_IVCHAN);
272 * De-mux PerlIO_openn() into fdopen, freopen and fopen type entries
276 PerlIO_openn(pTHX_ const char *layers, const char *mode, int fd,
277 int imode, int perm, PerlIO *old, int narg, SV **args)
281 Perl_croak(aTHX_ "More than one argument to open");
283 if (*args == &PL_sv_undef)
284 return PerlIO_tmpfile();
287 const char *name = SvPV_const(*args, len);
288 if (!IS_SAFE_PATHNAME(name, len, "open"))
291 if (*mode == IoTYPE_NUMERIC) {
292 fd = PerlLIO_open3_cloexec(name, imode, perm);
294 return PerlIO_fdopen(fd, mode + 1);
297 return PerlIO_reopen(name, mode, old);
300 return PerlIO_open(name, mode);
305 return PerlIO_fdopen(fd, (char *) mode);
310 XS(XS_PerlIO__Layer__find); /* prototype to pass -Wmissing-prototypes */
311 XS(XS_PerlIO__Layer__find)
315 Perl_croak(aTHX_ "Usage class->find(name[,load])");
317 const char * const name = SvPV_nolen_const(ST(1));
318 ST(0) = (strEQ(name, "crlf")
319 || strEQ(name, "raw")) ? &PL_sv_yes : &PL_sv_undef;
326 Perl_boot_core_PerlIO(pTHX)
328 newXS("PerlIO::Layer::find", XS_PerlIO__Layer__find, __FILE__);
334 /*======================================================================================*/
336 * Implement all the PerlIO interface ourselves.
342 PerlIO_debug(const char *fmt, ...)
352 if (!PL_perlio_debug_fd) {
354 PerlProc_getuid() == PerlProc_geteuid() &&
355 PerlProc_getgid() == PerlProc_getegid()) {
356 const char * const s = PerlEnv_getenv("PERLIO_DEBUG");
358 PL_perlio_debug_fd = PerlLIO_open3_cloexec(s,
359 O_WRONLY | O_CREAT | O_APPEND, 0666);
361 PL_perlio_debug_fd = PerlLIO_dup_cloexec(2); /* stderr */
363 /* tainting or set*id, so ignore the environment and send the
364 debug output to stderr, like other -D switches. */
365 PL_perlio_debug_fd = PerlLIO_dup_cloexec(2); /* stderr */
368 if (PL_perlio_debug_fd > 0) {
370 const char * const s = CopFILE(PL_curcop);
371 /* Use fixed buffer as sv_catpvf etc. needs SVs */
373 const STRLEN len1 = my_snprintf(buffer, sizeof(buffer), "%.40s:%" IVdf " ", s ? s : "(none)", (IV) CopLINE(PL_curcop));
375 # ifdef HAS_VSNPRINTF
376 /* my_vsnprintf() isn't available with quadmath, but the native vsnprintf()
377 should be, otherwise the system isn't likely to support quadmath.
378 Nothing should be calling PerlIO_debug() with floating point anyway.
380 const STRLEN len2 = vsnprintf(buffer + len1, sizeof(buffer) - len1, fmt, ap);
382 STATIC_ASSERT_STMT(0);
385 const STRLEN len2 = my_vsnprintf(buffer + len1, sizeof(buffer) - len1, fmt, ap);
387 PERL_UNUSED_RESULT(PerlLIO_write(PL_perlio_debug_fd, buffer, len1 + len2));
389 const char *s = CopFILE(PL_curcop);
391 SV * const sv = Perl_newSVpvf(aTHX_ "%s:%" IVdf " ", s ? s : "(none)",
392 (IV) CopLINE(PL_curcop));
393 Perl_sv_vcatpvf(aTHX_ sv, fmt, &ap);
395 s = SvPV_const(sv, len);
396 PERL_UNUSED_RESULT(PerlLIO_write(PL_perlio_debug_fd, s, len));
403 /*--------------------------------------------------------------------------------------*/
406 * Inner level routines
409 /* check that the head field of each layer points back to the head */
412 # define VERIFY_HEAD(f) PerlIO_verify_head(aTHX_ f)
414 PerlIO_verify_head(pTHX_ PerlIO *f)
418 #ifndef PERL_IMPLICIT_SYS
423 p = head = PerlIOBase(f)->head;
426 assert(p->head == head);
427 if (p == (PerlIOl*)f)
434 # define VERIFY_HEAD(f)
439 * Table of pointers to the PerlIO structs (malloc'ed)
441 #define PERLIO_TABLE_SIZE 64
444 PerlIO_init_table(pTHX)
448 Newxz(PL_perlio, PERLIO_TABLE_SIZE, PerlIOl);
454 PerlIO_allocate(pTHX)
457 * Find a free slot in the table, allocating new table as necessary
462 while ((f = *last)) {
464 last = (PerlIOl **) (f);
465 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
466 if (!((++f)->next)) {
471 Newxz(f,PERLIO_TABLE_SIZE,PerlIOl);
475 *last = (PerlIOl*) f++;
478 f->flags = 0; /* lockcnt */
484 #undef PerlIO_fdupopen
486 PerlIO_fdupopen(pTHX_ PerlIO *f, CLONE_PARAMS *param, int flags)
488 if (PerlIOValid(f)) {
489 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;
490 DEBUG_i( PerlIO_debug("fdupopen f=%p param=%p\n",(void*)f,(void*)param) );
492 return (*tab->Dup)(aTHX_ PerlIO_allocate(aTHX), f, param, flags);
494 return PerlIOBase_dup(aTHX_ PerlIO_allocate(aTHX), f, param, flags);
498 SETERRNO(EBADF, SS_IVCHAN);
504 PerlIO_cleantable(pTHX_ PerlIOl **tablep)
506 PerlIOl * const table = *tablep;
509 PerlIO_cleantable(aTHX_(PerlIOl **) & (table[0]));
510 for (i = PERLIO_TABLE_SIZE - 1; i > 0; i--) {
511 PerlIOl * const f = table + i;
513 PerlIO_close(&(f->next));
523 PerlIO_list_alloc(pTHX)
527 Newxz(list, 1, PerlIO_list_t);
533 PerlIO_list_free(pTHX_ PerlIO_list_t *list)
536 if (--list->refcnt == 0) {
539 for (i = 0; i < list->cur; i++)
540 SvREFCNT_dec(list->array[i].arg);
541 Safefree(list->array);
549 PerlIO_list_push(pTHX_ PerlIO_list_t *list, PerlIO_funcs *funcs, SV *arg)
554 if (list->cur >= list->len) {
555 const IV new_len = list->len + 8;
557 Renew(list->array, new_len, PerlIO_pair_t);
559 Newx(list->array, new_len, PerlIO_pair_t);
562 p = &(list->array[list->cur++]);
564 if ((p->arg = arg)) {
565 SvREFCNT_inc_simple_void_NN(arg);
570 PerlIO_clone_list(pTHX_ PerlIO_list_t *proto, CLONE_PARAMS *param)
572 PerlIO_list_t *list = NULL;
575 list = PerlIO_list_alloc(aTHX);
576 for (i=0; i < proto->cur; i++) {
577 SV *arg = proto->array[i].arg;
580 arg = sv_dup(arg, param);
582 PERL_UNUSED_ARG(param);
584 PerlIO_list_push(aTHX_ list, proto->array[i].funcs, arg);
591 PerlIO_clone(pTHX_ PerlInterpreter *proto, CLONE_PARAMS *param)
594 PerlIOl **table = &proto->Iperlio;
597 PL_known_layers = PerlIO_clone_list(aTHX_ proto->Iknown_layers, param);
598 PL_def_layerlist = PerlIO_clone_list(aTHX_ proto->Idef_layerlist, param);
599 PerlIO_init_table(aTHX);
600 DEBUG_i( PerlIO_debug("Clone %p from %p\n",(void*)aTHX,(void*)proto) );
601 while ((f = *table)) {
603 table = (PerlIOl **) (f++);
604 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
606 (void) fp_dup(&(f->next), 0, param);
613 PERL_UNUSED_ARG(proto);
614 PERL_UNUSED_ARG(param);
619 PerlIO_destruct(pTHX)
621 PerlIOl **table = &PL_perlio;
624 DEBUG_i( PerlIO_debug("Destruct %p\n",(void*)aTHX) );
626 while ((f = *table)) {
628 table = (PerlIOl **) (f++);
629 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
630 PerlIO *x = &(f->next);
633 if (l->tab && l->tab->kind & PERLIO_K_DESTRUCT) {
634 DEBUG_i( PerlIO_debug("Destruct popping %s\n", l->tab->name) );
648 PerlIO_pop(pTHX_ PerlIO *f)
650 const PerlIOl *l = *f;
653 DEBUG_i( PerlIO_debug("PerlIO_pop f=%p %s\n", (void*)f,
654 l->tab ? l->tab->name : "(Null)") );
655 if (l->tab && l->tab->Popped) {
657 * If popped returns non-zero do not free its layer structure
658 * it has either done so itself, or it is shared and still in
661 if ((*l->tab->Popped) (aTHX_ f) != 0)
664 if (PerlIO_lockcnt(f)) {
665 /* we're in use; defer freeing the structure */
666 PerlIOBase(f)->flags = PERLIO_F_CLEARED;
667 PerlIOBase(f)->tab = NULL;
677 /* Return as an array the stack of layers on a filehandle. Note that
678 * the stack is returned top-first in the array, and there are three
679 * times as many array elements as there are layers in the stack: the
680 * first element of a layer triplet is the name, the second one is the
681 * arguments, and the third one is the flags. */
684 PerlIO_get_layers(pTHX_ PerlIO *f)
686 AV * const av = newAV();
688 if (PerlIOValid(f)) {
689 PerlIOl *l = PerlIOBase(f);
692 /* There is some collusion in the implementation of
693 XS_PerlIO_get_layers - it knows that name and flags are
694 generated as fresh SVs here, and takes advantage of that to
695 "copy" them by taking a reference. If it changes here, it needs
696 to change there too. */
697 SV * const name = l->tab && l->tab->name ?
698 newSVpv(l->tab->name, 0) : &PL_sv_undef;
699 SV * const arg = l->tab && l->tab->Getarg ?
700 (*l->tab->Getarg)(aTHX_ &l, 0, 0) : &PL_sv_undef;
703 av_push(av, newSViv((IV)l->flags));
711 /*--------------------------------------------------------------------------------------*/
713 * XS Interface for perl code
717 PerlIO_find_layer(pTHX_ const char *name, STRLEN len, int load)
721 if ((SSize_t) len <= 0)
723 for (i = 0; i < PL_known_layers->cur; i++) {
724 PerlIO_funcs * const f = PL_known_layers->array[i].funcs;
725 const STRLEN this_len = strlen(f->name);
726 if (this_len == len && memEQ(f->name, name, len)) {
727 DEBUG_i( PerlIO_debug("%.*s => %p\n", (int) len, name, (void*)f) );
731 if (load && PL_subname && PL_def_layerlist
732 && PL_def_layerlist->cur >= 2) {
733 if (PL_in_load_module) {
734 Perl_croak(aTHX_ "Recursive call to Perl_load_module in PerlIO_find_layer");
737 SV * const pkgsv = newSVpvs("PerlIO");
738 SV * const layer = newSVpvn(name, len);
739 CV * const cv = get_cvs("PerlIO::Layer::NoWarnings", 0);
741 SAVEBOOL(PL_in_load_module);
743 SAVEGENERICSV(PL_warnhook);
744 PL_warnhook = MUTABLE_SV((SvREFCNT_inc_simple_NN(cv)));
746 PL_in_load_module = TRUE;
748 * The two SVs are magically freed by load_module
750 Perl_load_module(aTHX_ 0, pkgsv, NULL, layer, NULL);
752 return PerlIO_find_layer(aTHX_ name, len, 0);
755 DEBUG_i( PerlIO_debug("Cannot find %.*s\n", (int) len, name) );
759 #ifdef USE_ATTRIBUTES_FOR_PERLIO
762 perlio_mg_set(pTHX_ SV *sv, MAGIC *mg)
765 IO * const io = GvIOn(MUTABLE_GV(SvRV(sv)));
766 PerlIO * const ifp = IoIFP(io);
767 PerlIO * const ofp = IoOFP(io);
768 Perl_warn(aTHX_ "set %" SVf " %p %p %p",
769 SVfARG(sv), (void*)io, (void*)ifp, (void*)ofp);
775 perlio_mg_get(pTHX_ SV *sv, MAGIC *mg)
778 IO * const io = GvIOn(MUTABLE_GV(SvRV(sv)));
779 PerlIO * const ifp = IoIFP(io);
780 PerlIO * const ofp = IoOFP(io);
781 Perl_warn(aTHX_ "get %" SVf " %p %p %p",
782 SVfARG(sv), (void*)io, (void*)ifp, (void*)ofp);
788 perlio_mg_clear(pTHX_ SV *sv, MAGIC *mg)
790 Perl_warn(aTHX_ "clear %" SVf, SVfARG(sv));
795 perlio_mg_free(pTHX_ SV *sv, MAGIC *mg)
797 Perl_warn(aTHX_ "free %" SVf, SVfARG(sv));
801 MGVTBL perlio_vtab = {
809 XS(XS_io_MODIFY_SCALAR_ATTRIBUTES); /* prototype to pass -Wmissing-prototypes */
810 XS(XS_io_MODIFY_SCALAR_ATTRIBUTES)
813 SV * const sv = SvRV(ST(1));
814 AV * const av = newAV();
818 sv_magic(sv, MUTABLE_SV(av), PERL_MAGIC_ext, NULL, 0);
820 mg = mg_find(sv, PERL_MAGIC_ext);
821 mg->mg_virtual = &perlio_vtab;
823 Perl_warn(aTHX_ "attrib %" SVf, SVfARG(sv));
824 for (i = 2; i < items; i++) {
826 const char * const name = SvPV_const(ST(i), len);
827 SV * const layer = PerlIO_find_layer(aTHX_ name, len, 1);
829 av_push(av, SvREFCNT_inc_simple_NN(layer));
840 #endif /* USE_ATTRIBUTES_FOR_PERLIO */
843 PerlIO_tab_sv(pTHX_ PerlIO_funcs *tab)
845 HV * const stash = gv_stashpvs("PerlIO::Layer", GV_ADD);
846 SV * const sv = sv_bless(newRV_noinc(newSViv(PTR2IV(tab))), stash);
850 XS(XS_PerlIO__Layer__NoWarnings); /* prototype to pass -Wmissing-prototypes */
851 XS(XS_PerlIO__Layer__NoWarnings)
853 /* This is used as a %SIG{__WARN__} handler to suppress warnings
854 during loading of layers.
857 PERL_UNUSED_VAR(items);
860 PerlIO_debug("warning:%s\n",SvPV_nolen_const(ST(0))) );
864 XS(XS_PerlIO__Layer__find); /* prototype to pass -Wmissing-prototypes */
865 XS(XS_PerlIO__Layer__find)
869 Perl_croak(aTHX_ "Usage class->find(name[,load])");
872 const char * const name = SvPV_const(ST(1), len);
873 const bool load = (items > 2) ? SvTRUE_NN(ST(2)) : 0;
874 PerlIO_funcs * const layer = PerlIO_find_layer(aTHX_ name, len, load);
876 (layer) ? sv_2mortal(PerlIO_tab_sv(aTHX_ layer)) :
883 PerlIO_define_layer(pTHX_ PerlIO_funcs *tab)
885 if (!PL_known_layers)
886 PL_known_layers = PerlIO_list_alloc(aTHX);
887 PerlIO_list_push(aTHX_ PL_known_layers, tab, NULL);
888 DEBUG_i( PerlIO_debug("define %s %p\n", tab->name, (void*)tab) );
892 PerlIO_parse_layers(pTHX_ PerlIO_list_t *av, const char *names)
895 const char *s = names;
897 while (isSPACE(*s) || *s == ':')
902 const char *as = NULL;
904 if (!isIDFIRST(*s)) {
906 * Message is consistent with how attribute lists are
907 * passed. Even though this means "foo : : bar" is
908 * seen as an invalid separator character.
910 const char q = ((*s == '\'') ? '"' : '\'');
911 Perl_ck_warner(aTHX_ packWARN(WARN_LAYER),
912 "Invalid separator character %c%c%c in PerlIO layer specification %s",
914 SETERRNO(EINVAL, LIB_INVARG);
919 } while (isWORDCHAR(*e));
935 * It's a nul terminated string, not allowed
936 * to \ the terminating null. Anything other
937 * character is passed over.
945 Perl_ck_warner(aTHX_ packWARN(WARN_LAYER),
946 "Argument list not closed for PerlIO layer \"%.*s\"",
958 PerlIO_funcs * const layer =
959 PerlIO_find_layer(aTHX_ s, llen, 1);
963 arg = newSVpvn(as, alen);
964 PerlIO_list_push(aTHX_ av, layer,
965 (arg) ? arg : &PL_sv_undef);
969 Perl_ck_warner(aTHX_ packWARN(WARN_LAYER), "Unknown PerlIO layer \"%.*s\"",
982 PerlIO_default_buffer(pTHX_ PerlIO_list_t *av)
984 PERLIO_FUNCS_DECL(*tab) = &PerlIO_perlio;
985 #ifdef PERLIO_USING_CRLF
988 if (PerlIO_stdio.Set_ptrcnt)
991 DEBUG_i( PerlIO_debug("Pushing %s\n", tab->name) );
992 PerlIO_list_push(aTHX_ av, (PerlIO_funcs *)tab, &PL_sv_undef);
996 PerlIO_arg_fetch(PerlIO_list_t *av, IV n)
998 return av->array[n].arg;
1002 PerlIO_layer_fetch(pTHX_ PerlIO_list_t *av, IV n, PerlIO_funcs *def)
1004 if (n >= 0 && n < av->cur) {
1005 DEBUG_i( PerlIO_debug("Layer %" IVdf " is %s\n", n,
1006 av->array[n].funcs->name) );
1007 return av->array[n].funcs;
1010 Perl_croak(aTHX_ "panic: PerlIO layer array corrupt");
1015 PerlIOPop_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1017 PERL_UNUSED_ARG(mode);
1018 PERL_UNUSED_ARG(arg);
1019 PERL_UNUSED_ARG(tab);
1020 if (PerlIOValid(f)) {
1022 PerlIO_pop(aTHX_ f);
1028 PERLIO_FUNCS_DECL(PerlIO_remove) = {
1029 sizeof(PerlIO_funcs),
1032 PERLIO_K_DUMMY | PERLIO_K_UTF8,
1052 NULL, /* get_base */
1053 NULL, /* get_bufsiz */
1056 NULL, /* set_ptrcnt */
1060 PerlIO_default_layers(pTHX)
1062 if (!PL_def_layerlist) {
1063 const char * const s = TAINTING_get ? NULL : PerlEnv_getenv("PERLIO");
1064 PERLIO_FUNCS_DECL(*osLayer) = &PerlIO_unix;
1065 PL_def_layerlist = PerlIO_list_alloc(aTHX);
1066 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_unix));
1068 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_win32));
1070 osLayer = &PerlIO_win32;
1073 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_raw));
1074 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_perlio));
1075 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_stdio));
1076 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_crlf));
1077 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_utf8));
1078 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_remove));
1079 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_byte));
1080 PerlIO_list_push(aTHX_ PL_def_layerlist, (PerlIO_funcs *)osLayer,
1083 PerlIO_parse_layers(aTHX_ PL_def_layerlist, s);
1086 PerlIO_default_buffer(aTHX_ PL_def_layerlist);
1089 if (PL_def_layerlist->cur < 2) {
1090 PerlIO_default_buffer(aTHX_ PL_def_layerlist);
1092 return PL_def_layerlist;
1096 Perl_boot_core_PerlIO(pTHX)
1098 #ifdef USE_ATTRIBUTES_FOR_PERLIO
1099 newXS("io::MODIFY_SCALAR_ATTRIBUTES", XS_io_MODIFY_SCALAR_ATTRIBUTES,
1102 newXS("PerlIO::Layer::find", XS_PerlIO__Layer__find, __FILE__);
1103 newXS("PerlIO::Layer::NoWarnings", XS_PerlIO__Layer__NoWarnings, __FILE__);
1107 PerlIO_default_layer(pTHX_ I32 n)
1109 PerlIO_list_t * const av = PerlIO_default_layers(aTHX);
1112 return PerlIO_layer_fetch(aTHX_ av, n, PERLIO_FUNCS_CAST(&PerlIO_stdio));
1115 #define PerlIO_default_top() PerlIO_default_layer(aTHX_ -1)
1116 #define PerlIO_default_btm() PerlIO_default_layer(aTHX_ 0)
1119 PerlIO_stdstreams(pTHX)
1122 PerlIO_init_table(aTHX);
1123 PerlIO_fdopen(0, "Ir" PERLIO_STDTEXT);
1124 PerlIO_fdopen(1, "Iw" PERLIO_STDTEXT);
1125 PerlIO_fdopen(2, "Iw" PERLIO_STDTEXT);
1130 PerlIO_push(pTHX_ PerlIO *f, PERLIO_FUNCS_DECL(*tab), const char *mode, SV *arg)
1133 if (tab->fsize != sizeof(PerlIO_funcs)) {
1135 "%s (%" UVuf ") does not match %s (%" UVuf ")",
1136 "PerlIO layer function table size", (UV)tab->fsize,
1137 "size expected by this perl", (UV)sizeof(PerlIO_funcs) );
1141 if (tab->size < sizeof(PerlIOl)) {
1143 "%s (%" UVuf ") smaller than %s (%" UVuf ")",
1144 "PerlIO layer instance size", (UV)tab->size,
1145 "size expected by this perl", (UV)sizeof(PerlIOl) );
1147 /* Real layer with a data area */
1150 Newxz(temp, tab->size, char);
1154 l->tab = (PerlIO_funcs*) tab;
1155 l->head = ((PerlIOl*)f)->head;
1157 DEBUG_i( PerlIO_debug("PerlIO_push f=%p %s %s %p\n",
1158 (void*)f, tab->name,
1159 (mode) ? mode : "(Null)", (void*)arg) );
1160 if (*l->tab->Pushed &&
1162 (aTHX_ f, mode, arg, (PerlIO_funcs*) tab) != 0) {
1163 PerlIO_pop(aTHX_ f);
1172 /* Pseudo-layer where push does its own stack adjust */
1173 DEBUG_i( PerlIO_debug("PerlIO_push f=%p %s %s %p\n", (void*)f, tab->name,
1174 (mode) ? mode : "(Null)", (void*)arg) );
1176 (*tab->Pushed) (aTHX_ f, mode, arg, (PerlIO_funcs*) tab) != 0) {
1184 PerlIOBase_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
1185 IV n, const char *mode, int fd, int imode, int perm,
1186 PerlIO *old, int narg, SV **args)
1188 PerlIO_funcs * const tab = PerlIO_layer_fetch(aTHX_ layers, n - 1, PerlIO_default_layer(aTHX_ 0));
1189 if (tab && tab->Open) {
1190 PerlIO* ret = (*tab->Open)(aTHX_ tab, layers, n - 1, mode, fd, imode, perm, old, narg, args);
1191 if (ret && PerlIO_push(aTHX_ ret, self, mode, PerlIOArg) == NULL) {
1197 SETERRNO(EINVAL, LIB_INVARG);
1202 PerlIOBase_binmode(pTHX_ PerlIO *f)
1204 if (PerlIOValid(f)) {
1205 /* Is layer suitable for raw stream ? */
1206 if (PerlIOBase(f)->tab && PerlIOBase(f)->tab->kind & PERLIO_K_RAW) {
1207 /* Yes - turn off UTF-8-ness, to undo UTF-8 locale effects */
1208 PerlIOBase(f)->flags &= ~PERLIO_F_UTF8;
1211 /* Not suitable - pop it */
1212 PerlIO_pop(aTHX_ f);
1220 PerlIORaw_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1222 PERL_UNUSED_ARG(mode);
1223 PERL_UNUSED_ARG(arg);
1224 PERL_UNUSED_ARG(tab);
1226 if (PerlIOValid(f)) {
1231 * Strip all layers that are not suitable for a raw stream
1234 while (t && (l = *t)) {
1235 if (l->tab && l->tab->Binmode) {
1236 /* Has a handler - normal case */
1237 if ((*l->tab->Binmode)(aTHX_ t) == 0) {
1239 /* Layer still there - move down a layer */
1248 /* No handler - pop it */
1249 PerlIO_pop(aTHX_ t);
1252 if (PerlIOValid(f)) {
1253 DEBUG_i( PerlIO_debug(":raw f=%p :%s\n", (void*)f,
1254 PerlIOBase(f)->tab ? PerlIOBase(f)->tab->name : "(Null)") );
1262 PerlIO_apply_layera(pTHX_ PerlIO *f, const char *mode,
1263 PerlIO_list_t *layers, IV n, IV max)
1267 PerlIO_funcs * const tab = PerlIO_layer_fetch(aTHX_ layers, n, NULL);
1269 if (!PerlIO_push(aTHX_ f, tab, mode, PerlIOArg)) {
1280 PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode, const char *names)
1284 save_scalar(PL_errgv);
1286 PerlIO_list_t * const layers = PerlIO_list_alloc(aTHX);
1287 code = PerlIO_parse_layers(aTHX_ layers, names);
1289 code = PerlIO_apply_layera(aTHX_ f, mode, layers, 0, layers->cur);
1291 PerlIO_list_free(aTHX_ layers);
1298 /*--------------------------------------------------------------------------------------*/
1300 * Given the abstraction above the public API functions
1304 PerlIO_binmode(pTHX_ PerlIO *f, int iotype, int mode, const char *names)
1306 PERL_UNUSED_ARG(iotype);
1307 PERL_UNUSED_ARG(mode);
1310 PerlIO_debug("PerlIO_binmode f=%p %s %c %x %s\n", (void*)f,
1311 (PerlIOBase(f) && PerlIOBase(f)->tab) ?
1312 PerlIOBase(f)->tab->name : "(Null)",
1313 iotype, mode, (names) ? names : "(Null)") );
1316 /* Do not flush etc. if (e.g.) switching encodings.
1317 if a pushed layer knows it needs to flush lower layers
1318 (for example :unix which is never going to call them)
1319 it can do the flush when it is pushed.
1321 return cBOOL(PerlIO_apply_layers(aTHX_ f, NULL, names) == 0);
1324 /* Fake 5.6 legacy of using this call to turn ON O_TEXT */
1325 #ifdef PERLIO_USING_CRLF
1326 /* Legacy binmode only has meaning if O_TEXT has a value distinct from
1327 O_BINARY so we can look for it in mode.
1329 if (!(mode & O_BINARY)) {
1331 /* FIXME?: Looking down the layer stack seems wrong,
1332 but is a way of reaching past (say) an encoding layer
1333 to flip CRLF-ness of the layer(s) below
1336 /* Perhaps we should turn on bottom-most aware layer
1337 e.g. Ilya's idea that UNIX TTY could serve
1339 if (PerlIOBase(f)->tab &&
1340 PerlIOBase(f)->tab->kind & PERLIO_K_CANCRLF)
1342 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF)) {
1343 /* Not in text mode - flush any pending stuff and flip it */
1345 PerlIOBase(f)->flags |= PERLIO_F_CRLF;
1347 /* Only need to turn it on in one layer so we are done */
1352 /* Not finding a CRLF aware layer presumably means we are binary
1353 which is not what was requested - so we failed
1354 We _could_ push :crlf layer but so could caller
1359 /* Legacy binmode is now _defined_ as being equivalent to pushing :raw
1360 So code that used to be here is now in PerlIORaw_pushed().
1362 return cBOOL(PerlIO_push(aTHX_ f, PERLIO_FUNCS_CAST(&PerlIO_raw), NULL, NULL));
1367 PerlIO__close(pTHX_ PerlIO *f)
1369 if (PerlIOValid(f)) {
1370 PerlIO_funcs * const tab = PerlIOBase(f)->tab;
1371 if (tab && tab->Close)
1372 return (*tab->Close)(aTHX_ f);
1374 return PerlIOBase_close(aTHX_ f);
1377 SETERRNO(EBADF, SS_IVCHAN);
1383 Perl_PerlIO_close(pTHX_ PerlIO *f)
1385 const int code = PerlIO__close(aTHX_ f);
1386 while (PerlIOValid(f)) {
1387 PerlIO_pop(aTHX_ f);
1388 if (PerlIO_lockcnt(f))
1389 /* we're in use; the 'pop' deferred freeing the structure */
1396 Perl_PerlIO_fileno(pTHX_ PerlIO *f)
1398 Perl_PerlIO_or_Base(f, Fileno, fileno, -1, (aTHX_ f));
1402 static PerlIO_funcs *
1403 PerlIO_layer_from_ref(pTHX_ SV *sv)
1406 * For any scalar type load the handler which is bundled with perl
1408 if (SvTYPE(sv) < SVt_PVAV && (!isGV_with_GP(sv) || SvFAKE(sv))) {
1409 PerlIO_funcs *f = PerlIO_find_layer(aTHX_ STR_WITH_LEN("scalar"), 1);
1410 /* This isn't supposed to happen, since PerlIO::scalar is core,
1411 * but could happen anyway in smaller installs or with PAR */
1413 /* diag_listed_as: Unknown PerlIO layer "%s" */
1414 Perl_ck_warner(aTHX_ packWARN(WARN_LAYER), "Unknown PerlIO layer \"scalar\"");
1419 * For other types allow if layer is known but don't try and load it
1421 switch (SvTYPE(sv)) {
1423 return PerlIO_find_layer(aTHX_ STR_WITH_LEN("Array"), 0);
1425 return PerlIO_find_layer(aTHX_ STR_WITH_LEN("Hash"), 0);
1427 return PerlIO_find_layer(aTHX_ STR_WITH_LEN("Code"), 0);
1429 return PerlIO_find_layer(aTHX_ STR_WITH_LEN("Glob"), 0);
1436 PerlIO_resolve_layers(pTHX_ const char *layers,
1437 const char *mode, int narg, SV **args)
1439 PerlIO_list_t *def = PerlIO_default_layers(aTHX);
1442 PerlIO_stdstreams(aTHX);
1444 SV * const arg = *args;
1446 * If it is a reference but not an object see if we have a handler
1449 if (SvROK(arg) && !SvOBJECT(SvRV(arg))) {
1450 PerlIO_funcs * const handler = PerlIO_layer_from_ref(aTHX_ SvRV(arg));
1452 def = PerlIO_list_alloc(aTHX);
1453 PerlIO_list_push(aTHX_ def, handler, &PL_sv_undef);
1457 * Don't fail if handler cannot be found :via(...) etc. may do
1458 * something sensible else we will just stringfy and open
1463 if (!layers || !*layers)
1464 layers = Perl_PerlIO_context_layers(aTHX_ mode);
1465 if (layers && *layers) {
1468 av = PerlIO_clone_list(aTHX_ def, NULL);
1473 if (PerlIO_parse_layers(aTHX_ av, layers) == 0) {
1477 PerlIO_list_free(aTHX_ av);
1489 PerlIO_openn(pTHX_ const char *layers, const char *mode, int fd,
1490 int imode, int perm, PerlIO *f, int narg, SV **args)
1492 if (!f && narg == 1 && *args == &PL_sv_undef) {
1493 imode = PerlIOUnix_oflags(mode);
1495 if (imode != -1 && (f = PerlIO_tmpfile_flags(imode))) {
1496 if (!layers || !*layers)
1497 layers = Perl_PerlIO_context_layers(aTHX_ mode);
1498 if (layers && *layers)
1499 PerlIO_apply_layers(aTHX_ f, mode, layers);
1503 PerlIO_list_t *layera;
1505 PerlIO_funcs *tab = NULL;
1506 if (PerlIOValid(f)) {
1508 * This is "reopen" - it is not tested as perl does not use it
1512 layera = PerlIO_list_alloc(aTHX);
1515 if (l->tab && l->tab->Getarg)
1516 arg = (*l->tab->Getarg) (aTHX_ &l, NULL, 0);
1517 PerlIO_list_push(aTHX_ layera, l->tab,
1518 (arg) ? arg : &PL_sv_undef);
1520 l = *PerlIONext(&l);
1524 layera = PerlIO_resolve_layers(aTHX_ layers, mode, narg, args);
1530 * Start at "top" of layer stack
1532 n = layera->cur - 1;
1534 PerlIO_funcs * const t = PerlIO_layer_fetch(aTHX_ layera, n, NULL);
1543 * Found that layer 'n' can do opens - call it
1545 if (narg > 1 && !(tab->kind & PERLIO_K_MULTIARG)) {
1546 Perl_croak(aTHX_ "More than one argument to open(,':%s')",tab->name);
1548 DEBUG_i( PerlIO_debug("openn(%s,'%s','%s',%d,%x,%o,%p,%d,%p)\n",
1549 tab->name, layers ? layers : "(Null)", mode, fd,
1550 imode, perm, (void*)f, narg, (void*)args) );
1552 f = (*tab->Open) (aTHX_ tab, layera, n, mode, fd, imode, perm,
1555 SETERRNO(EINVAL, LIB_INVARG);
1559 if (n + 1 < layera->cur) {
1561 * More layers above the one that we used to open -
1564 if (PerlIO_apply_layera(aTHX_ f, mode, layera, n + 1, layera->cur) != 0) {
1565 /* If pushing layers fails close the file */
1572 PerlIO_list_free(aTHX_ layera);
1579 Perl_PerlIO_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
1581 PERL_ARGS_ASSERT_PERLIO_READ;
1583 Perl_PerlIO_or_Base(f, Read, read, -1, (aTHX_ f, vbuf, count));
1587 Perl_PerlIO_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
1589 PERL_ARGS_ASSERT_PERLIO_UNREAD;
1591 Perl_PerlIO_or_Base(f, Unread, unread, -1, (aTHX_ f, vbuf, count));
1595 Perl_PerlIO_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
1597 PERL_ARGS_ASSERT_PERLIO_WRITE;
1599 Perl_PerlIO_or_fail(f, Write, -1, (aTHX_ f, vbuf, count));
1603 Perl_PerlIO_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
1605 Perl_PerlIO_or_fail(f, Seek, -1, (aTHX_ f, offset, whence));
1609 Perl_PerlIO_tell(pTHX_ PerlIO *f)
1611 Perl_PerlIO_or_fail(f, Tell, -1, (aTHX_ f));
1615 Perl_PerlIO_flush(pTHX_ PerlIO *f)
1619 const PerlIO_funcs *tab = PerlIOBase(f)->tab;
1621 if (tab && tab->Flush)
1622 return (*tab->Flush) (aTHX_ f);
1624 return 0; /* If no Flush defined, silently succeed. */
1627 DEBUG_i( PerlIO_debug("Cannot flush f=%p\n", (void*)f) );
1628 SETERRNO(EBADF, SS_IVCHAN);
1634 * Is it good API design to do flush-all on NULL, a potentially
1635 * erroneous input? Maybe some magical value (PerlIO*
1636 * PERLIO_FLUSH_ALL = (PerlIO*)-1;)? Yes, stdio does similar
1637 * things on fflush(NULL), but should we be bound by their design
1640 PerlIOl **table = &PL_perlio;
1643 while ((ff = *table)) {
1645 table = (PerlIOl **) (ff++);
1646 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
1647 if (ff->next && PerlIO_flush(&(ff->next)) != 0)
1657 PerlIOBase_flush_linebuf(pTHX)
1659 PerlIOl **table = &PL_perlio;
1661 while ((f = *table)) {
1663 table = (PerlIOl **) (f++);
1664 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
1666 && (PerlIOBase(&(f->next))->
1667 flags & (PERLIO_F_LINEBUF | PERLIO_F_CANWRITE))
1668 == (PERLIO_F_LINEBUF | PERLIO_F_CANWRITE))
1669 PerlIO_flush(&(f->next));
1676 Perl_PerlIO_fill(pTHX_ PerlIO *f)
1678 Perl_PerlIO_or_fail(f, Fill, -1, (aTHX_ f));
1682 PerlIO_isutf8(PerlIO *f)
1685 return (PerlIOBase(f)->flags & PERLIO_F_UTF8) != 0;
1687 SETERRNO(EBADF, SS_IVCHAN);
1693 Perl_PerlIO_eof(pTHX_ PerlIO *f)
1695 Perl_PerlIO_or_Base(f, Eof, eof, -1, (aTHX_ f));
1699 Perl_PerlIO_error(pTHX_ PerlIO *f)
1701 Perl_PerlIO_or_Base(f, Error, error, -1, (aTHX_ f));
1705 Perl_PerlIO_clearerr(pTHX_ PerlIO *f)
1707 Perl_PerlIO_or_Base_void(f, Clearerr, clearerr, (aTHX_ f));
1711 Perl_PerlIO_setlinebuf(pTHX_ PerlIO *f)
1713 Perl_PerlIO_or_Base_void(f, Setlinebuf, setlinebuf, (aTHX_ f));
1717 PerlIO_has_base(PerlIO *f)
1719 if (PerlIOValid(f)) {
1720 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;
1723 return (tab->Get_base != NULL);
1730 PerlIO_fast_gets(PerlIO *f)
1732 if (PerlIOValid(f)) {
1733 if (PerlIOBase(f)->flags & PERLIO_F_FASTGETS) {
1734 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;
1737 return (tab->Set_ptrcnt != NULL);
1745 PerlIO_has_cntptr(PerlIO *f)
1747 if (PerlIOValid(f)) {
1748 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;
1751 return (tab->Get_ptr != NULL && tab->Get_cnt != NULL);
1758 PerlIO_canset_cnt(PerlIO *f)
1760 if (PerlIOValid(f)) {
1761 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;
1764 return (tab->Set_ptrcnt != NULL);
1771 Perl_PerlIO_get_base(pTHX_ PerlIO *f)
1773 Perl_PerlIO_or_fail(f, Get_base, NULL, (aTHX_ f));
1777 Perl_PerlIO_get_bufsiz(pTHX_ PerlIO *f)
1779 /* Note that Get_bufsiz returns a Size_t */
1780 Perl_PerlIO_or_fail(f, Get_bufsiz, -1, (aTHX_ f));
1784 Perl_PerlIO_get_ptr(pTHX_ PerlIO *f)
1786 Perl_PerlIO_or_fail(f, Get_ptr, NULL, (aTHX_ f));
1790 Perl_PerlIO_get_cnt(pTHX_ PerlIO *f)
1792 Perl_PerlIO_or_fail(f, Get_cnt, -1, (aTHX_ f));
1796 Perl_PerlIO_set_cnt(pTHX_ PerlIO *f, SSize_t cnt)
1798 Perl_PerlIO_or_fail_void(f, Set_ptrcnt, (aTHX_ f, NULL, cnt));
1802 Perl_PerlIO_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
1804 Perl_PerlIO_or_fail_void(f, Set_ptrcnt, (aTHX_ f, ptr, cnt));
1808 /*--------------------------------------------------------------------------------------*/
1810 * utf8 and raw dummy layers
1814 PerlIOUtf8_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1816 PERL_UNUSED_CONTEXT;
1817 PERL_UNUSED_ARG(mode);
1818 PERL_UNUSED_ARG(arg);
1819 if (PerlIOValid(f)) {
1820 if (tab && tab->kind & PERLIO_K_UTF8)
1821 PerlIOBase(f)->flags |= PERLIO_F_UTF8;
1823 PerlIOBase(f)->flags &= ~PERLIO_F_UTF8;
1829 PERLIO_FUNCS_DECL(PerlIO_utf8) = {
1830 sizeof(PerlIO_funcs),
1833 PERLIO_K_DUMMY | PERLIO_K_UTF8 | PERLIO_K_MULTIARG,
1853 NULL, /* get_base */
1854 NULL, /* get_bufsiz */
1857 NULL, /* set_ptrcnt */
1860 PERLIO_FUNCS_DECL(PerlIO_byte) = {
1861 sizeof(PerlIO_funcs),
1864 PERLIO_K_DUMMY | PERLIO_K_MULTIARG,
1884 NULL, /* get_base */
1885 NULL, /* get_bufsiz */
1888 NULL, /* set_ptrcnt */
1891 PERLIO_FUNCS_DECL(PerlIO_raw) = {
1892 sizeof(PerlIO_funcs),
1915 NULL, /* get_base */
1916 NULL, /* get_bufsiz */
1919 NULL, /* set_ptrcnt */
1921 /*--------------------------------------------------------------------------------------*/
1922 /*--------------------------------------------------------------------------------------*/
1924 * "Methods" of the "base class"
1928 PerlIOBase_fileno(pTHX_ PerlIO *f)
1930 return PerlIOValid(f) ? PerlIO_fileno(PerlIONext(f)) : -1;
1934 PerlIO_modestr(PerlIO * f, char *buf)
1937 if (PerlIOValid(f)) {
1938 const IV flags = PerlIOBase(f)->flags;
1939 if (flags & PERLIO_F_APPEND) {
1941 if (flags & PERLIO_F_CANREAD) {
1945 else if (flags & PERLIO_F_CANREAD) {
1947 if (flags & PERLIO_F_CANWRITE)
1950 else if (flags & PERLIO_F_CANWRITE) {
1952 if (flags & PERLIO_F_CANREAD) {
1956 #ifdef PERLIO_USING_CRLF
1957 if (!(flags & PERLIO_F_CRLF))
1967 PerlIOBase_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1969 PerlIOl * const l = PerlIOBase(f);
1970 PERL_UNUSED_CONTEXT;
1971 PERL_UNUSED_ARG(arg);
1973 l->flags &= ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE |
1974 PERLIO_F_TRUNCATE | PERLIO_F_APPEND);
1975 if (tab && tab->Set_ptrcnt != NULL)
1976 l->flags |= PERLIO_F_FASTGETS;
1978 if (*mode == IoTYPE_NUMERIC || *mode == IoTYPE_IMPLICIT)
1982 l->flags |= PERLIO_F_CANREAD;
1985 l->flags |= PERLIO_F_APPEND | PERLIO_F_CANWRITE;
1988 l->flags |= PERLIO_F_TRUNCATE | PERLIO_F_CANWRITE;
1991 SETERRNO(EINVAL, LIB_INVARG);
1996 /* The mode variable contains one positional parameter followed by
1997 * optional keyword parameters. The positional parameters must be
1998 * passed as lowercase characters. The keyword parameters can be
1999 * passed in mixed case. They must be separated by commas. Only one
2000 * instance of a keyword can be specified. */
2006 l->flags |= PERLIO_F_CANREAD | PERLIO_F_CANWRITE;
2010 l->flags &= ~PERLIO_F_CRLF;
2014 l->flags |= PERLIO_F_CRLF;
2028 l->flags |= PERLIO_F_CANREAD | PERLIO_F_CANWRITE;
2031 l->flags &= ~PERLIO_F_CRLF;
2034 l->flags |= PERLIO_F_CRLF;
2037 SETERRNO(EINVAL, LIB_INVARG);
2045 l->flags |= l->next->flags &
2046 (PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_TRUNCATE |
2052 PerlIO_debug("PerlIOBase_pushed f=%p %s %s fl=%08" UVxf " (%s)\n",
2053 (void*)f, PerlIOBase(f)->tab->name, (omode) ? omode : "(Null)",
2054 l->flags, PerlIO_modestr(f, temp));
2061 PerlIOBase_popped(pTHX_ PerlIO *f)
2063 PERL_UNUSED_CONTEXT;
2069 PerlIOBase_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
2072 * Save the position as current head considers it
2074 const Off_t old = PerlIO_tell(f);
2075 PerlIO_push(aTHX_ f, PERLIO_FUNCS_CAST(&PerlIO_pending), "r", NULL);
2076 PerlIOSelf(f, PerlIOBuf)->posn = old;
2077 return PerlIOBuf_unread(aTHX_ f, vbuf, count);
2081 PerlIOBase_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
2083 STDCHAR *buf = (STDCHAR *) vbuf;
2085 if (!(PerlIOBase(f)->flags & PERLIO_F_CANREAD)) {
2086 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2087 SETERRNO(EBADF, SS_IVCHAN);
2088 PerlIO_save_errno(f);
2094 SSize_t avail = PerlIO_get_cnt(f);
2097 take = (((SSize_t) count >= 0) && ((SSize_t)count < avail)) ? (SSize_t)count : avail;
2099 STDCHAR *ptr = PerlIO_get_ptr(f);
2100 Copy(ptr, buf, take, STDCHAR);
2101 PerlIO_set_ptrcnt(f, ptr + take, (avail -= take));
2104 if (avail == 0) /* set_ptrcnt could have reset avail */
2107 if (count > 0 && avail <= 0) {
2108 if (PerlIO_fill(f) != 0)
2113 return (buf - (STDCHAR *) vbuf);
2119 PerlIOBase_noop_ok(pTHX_ PerlIO *f)
2121 PERL_UNUSED_CONTEXT;
2127 PerlIOBase_noop_fail(pTHX_ PerlIO *f)
2129 PERL_UNUSED_CONTEXT;
2135 PerlIOBase_close(pTHX_ PerlIO *f)
2138 if (PerlIOValid(f)) {
2139 PerlIO *n = PerlIONext(f);
2140 code = PerlIO_flush(f);
2141 PerlIOBase(f)->flags &=
2142 ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_OPEN);
2143 while (PerlIOValid(n)) {
2144 const PerlIO_funcs * const tab = PerlIOBase(n)->tab;
2145 if (tab && tab->Close) {
2146 if ((*tab->Close)(aTHX_ n) != 0)
2151 PerlIOBase(n)->flags &=
2152 ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_OPEN);
2158 SETERRNO(EBADF, SS_IVCHAN);
2164 PerlIOBase_eof(pTHX_ PerlIO *f)
2166 PERL_UNUSED_CONTEXT;
2167 if (PerlIOValid(f)) {
2168 return (PerlIOBase(f)->flags & PERLIO_F_EOF) != 0;
2174 PerlIOBase_error(pTHX_ PerlIO *f)
2176 PERL_UNUSED_CONTEXT;
2177 if (PerlIOValid(f)) {
2178 return (PerlIOBase(f)->flags & PERLIO_F_ERROR) != 0;
2184 PerlIOBase_clearerr(pTHX_ PerlIO *f)
2186 if (PerlIOValid(f)) {
2187 PerlIO * const n = PerlIONext(f);
2188 PerlIOBase(f)->flags &= ~(PERLIO_F_ERROR | PERLIO_F_EOF);
2195 PerlIOBase_setlinebuf(pTHX_ PerlIO *f)
2197 PERL_UNUSED_CONTEXT;
2198 if (PerlIOValid(f)) {
2199 PerlIOBase(f)->flags |= PERLIO_F_LINEBUF;
2204 PerlIO_sv_dup(pTHX_ SV *arg, CLONE_PARAMS *param)
2210 arg = sv_dup(arg, param);
2211 SvREFCNT_inc_simple_void_NN(arg);
2215 return newSVsv(arg);
2218 PERL_UNUSED_ARG(param);
2219 return newSVsv(arg);
2224 PerlIOBase_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2226 PerlIO * const nexto = PerlIONext(o);
2227 if (PerlIOValid(nexto)) {
2228 const PerlIO_funcs * const tab = PerlIOBase(nexto)->tab;
2229 if (tab && tab->Dup)
2230 f = (*tab->Dup)(aTHX_ f, nexto, param, flags);
2232 f = PerlIOBase_dup(aTHX_ f, nexto, param, flags);
2235 PerlIO_funcs * const self = PerlIOBase(o)->tab;
2239 DEBUG_i(PerlIO_debug("PerlIOBase_dup %s f=%p o=%p param=%p\n",
2241 (void*)f, (void*)o, (void*)param) );
2243 arg = (*self->Getarg)(aTHX_ o, param, flags);
2244 f = PerlIO_push(aTHX_ f, self, PerlIO_modestr(o,buf), arg);
2245 if (f && PerlIOBase(o)->flags & PERLIO_F_UTF8)
2246 PerlIOBase(f)->flags |= PERLIO_F_UTF8;
2252 /* PL_perlio_fd_refcnt[] is in intrpvar.h */
2254 /* Must be called with PL_perlio_mutex locked. */
2256 S_more_refcounted_fds(pTHX_ const int new_fd)
2257 PERL_TSA_REQUIRES(PL_perlio_mutex)
2259 const int old_max = PL_perlio_fd_refcnt_size;
2260 const int new_max = 16 + (new_fd & ~15);
2263 #ifndef PERL_IMPLICIT_SYS
2264 PERL_UNUSED_CONTEXT;
2267 DEBUG_i( PerlIO_debug("More fds - old=%d, need %d, new=%d\n",
2268 old_max, new_fd, new_max) );
2270 if (new_fd < old_max) {
2274 assert (new_max > new_fd);
2276 /* Use plain realloc() since we need this memory to be really
2277 * global and visible to all the interpreters and/or threads. */
2278 new_array = (int*) realloc(PL_perlio_fd_refcnt, new_max * sizeof(int));
2281 MUTEX_UNLOCK(&PL_perlio_mutex);
2285 PL_perlio_fd_refcnt_size = new_max;
2286 PL_perlio_fd_refcnt = new_array;
2288 DEBUG_i( PerlIO_debug("Zeroing %p, %d\n",
2289 (void*)(new_array + old_max),
2290 new_max - old_max) );
2292 Zero(new_array + old_max, new_max - old_max, int);
2299 /* MUTEX_INIT(&PL_perlio_mutex) is done in PERL_SYS_INIT3(). */
2300 PERL_UNUSED_CONTEXT;
2304 PerlIOUnix_refcnt_inc(int fd)
2309 MUTEX_LOCK(&PL_perlio_mutex);
2310 if (fd >= PL_perlio_fd_refcnt_size)
2311 S_more_refcounted_fds(aTHX_ fd);
2313 PL_perlio_fd_refcnt[fd]++;
2314 if (PL_perlio_fd_refcnt[fd] <= 0) {
2315 /* diag_listed_as: refcnt_inc: fd %d%s */
2316 Perl_croak(aTHX_ "refcnt_inc: fd %d: %d <= 0\n",
2317 fd, PL_perlio_fd_refcnt[fd]);
2319 DEBUG_i( PerlIO_debug("refcnt_inc: fd %d refcnt=%d\n",
2320 fd, PL_perlio_fd_refcnt[fd]) );
2322 MUTEX_UNLOCK(&PL_perlio_mutex);
2324 /* diag_listed_as: refcnt_inc: fd %d%s */
2325 Perl_croak(aTHX_ "refcnt_inc: fd %d < 0\n", fd);
2330 PerlIOUnix_refcnt_dec(int fd)
2338 MUTEX_LOCK(&PL_perlio_mutex);
2339 if (fd >= PL_perlio_fd_refcnt_size) {
2340 /* diag_listed_as: refcnt_dec: fd %d%s */
2341 Perl_croak_nocontext("refcnt_dec: fd %d >= refcnt_size %d\n",
2342 fd, PL_perlio_fd_refcnt_size);
2344 if (PL_perlio_fd_refcnt[fd] <= 0) {
2345 /* diag_listed_as: refcnt_dec: fd %d%s */
2346 Perl_croak_nocontext("refcnt_dec: fd %d: %d <= 0\n",
2347 fd, PL_perlio_fd_refcnt[fd]);
2349 cnt = --PL_perlio_fd_refcnt[fd];
2350 DEBUG_i( PerlIO_debug("refcnt_dec: fd %d refcnt=%d\n", fd, cnt) );
2351 MUTEX_UNLOCK(&PL_perlio_mutex);
2353 /* diag_listed_as: refcnt_dec: fd %d%s */
2354 Perl_croak_nocontext("refcnt_dec: fd %d < 0\n", fd);
2360 PerlIOUnix_refcnt(int fd)
2365 MUTEX_LOCK(&PL_perlio_mutex);
2366 if (fd >= PL_perlio_fd_refcnt_size) {
2367 /* diag_listed_as: refcnt: fd %d%s */
2368 Perl_croak(aTHX_ "refcnt: fd %d >= refcnt_size %d\n",
2369 fd, PL_perlio_fd_refcnt_size);
2371 if (PL_perlio_fd_refcnt[fd] <= 0) {
2372 /* diag_listed_as: refcnt: fd %d%s */
2373 Perl_croak(aTHX_ "refcnt: fd %d: %d <= 0\n",
2374 fd, PL_perlio_fd_refcnt[fd]);
2376 cnt = PL_perlio_fd_refcnt[fd];
2377 MUTEX_UNLOCK(&PL_perlio_mutex);
2379 /* diag_listed_as: refcnt: fd %d%s */
2380 Perl_croak(aTHX_ "refcnt: fd %d < 0\n", fd);
2386 PerlIO_cleanup(pTHX)
2390 DEBUG_i( PerlIO_debug("Cleanup layers for %p\n",(void*)aTHX) );
2392 DEBUG_i( PerlIO_debug("Cleanup layers\n") );
2395 /* Raise STDIN..STDERR refcount so we don't close them */
2396 for (i=0; i < 3; i++)
2397 PerlIOUnix_refcnt_inc(i);
2398 PerlIO_cleantable(aTHX_ &PL_perlio);
2399 /* Restore STDIN..STDERR refcount */
2400 for (i=0; i < 3; i++)
2401 PerlIOUnix_refcnt_dec(i);
2403 if (PL_known_layers) {
2404 PerlIO_list_free(aTHX_ PL_known_layers);
2405 PL_known_layers = NULL;
2407 if (PL_def_layerlist) {
2408 PerlIO_list_free(aTHX_ PL_def_layerlist);
2409 PL_def_layerlist = NULL;
2413 void PerlIO_teardown(void) /* Call only from PERL_SYS_TERM(). */
2416 /* XXX we can't rely on an interpreter being present at this late stage,
2417 XXX so we can't use a function like PerlLIO_write that relies on one
2418 being present (at least in win32) :-(.
2423 /* By now all filehandles should have been closed, so any
2424 * stray (non-STD-)filehandles indicate *possible* (PerlIO)
2426 #define PERLIO_TEARDOWN_MESSAGE_BUF_SIZE 64
2427 #define PERLIO_TEARDOWN_MESSAGE_FD 2
2428 char buf[PERLIO_TEARDOWN_MESSAGE_BUF_SIZE];
2430 for (i = 3; i < PL_perlio_fd_refcnt_size; i++) {
2431 if (PL_perlio_fd_refcnt[i]) {
2433 my_snprintf(buf, sizeof(buf),
2434 "PerlIO_teardown: fd %d refcnt=%d\n",
2435 i, PL_perlio_fd_refcnt[i]);
2436 PerlLIO_write(PERLIO_TEARDOWN_MESSAGE_FD, buf, len);
2442 /* Not bothering with PL_perlio_mutex since by now
2443 * all the interpreters are gone. */
2444 if (PL_perlio_fd_refcnt_size /* Assuming initial size of zero. */
2445 && PL_perlio_fd_refcnt) {
2446 free(PL_perlio_fd_refcnt); /* To match realloc() in S_more_refcounted_fds(). */
2447 PL_perlio_fd_refcnt = NULL;
2448 PL_perlio_fd_refcnt_size = 0;
2452 /*--------------------------------------------------------------------------------------*/
2454 * Bottom-most level for UNIX-like case
2458 struct _PerlIO base; /* The generic part */
2459 int fd; /* UNIX like file descriptor */
2460 int oflags; /* open/fcntl flags */
2464 S_lockcnt_dec(pTHX_ const void* f)
2466 #ifndef PERL_IMPLICIT_SYS
2467 PERL_UNUSED_CONTEXT;
2469 PerlIO_lockcnt((PerlIO*)f)--;
2473 /* call the signal handler, and if that handler happens to clear
2474 * this handle, free what we can and return true */
2477 S_perlio_async_run(pTHX_ PerlIO* f) {
2479 SAVEDESTRUCTOR_X(S_lockcnt_dec, (void*)f);
2480 PerlIO_lockcnt(f)++;
2482 if ( !(PerlIOBase(f)->flags & PERLIO_F_CLEARED) ) {
2486 /* we've just run some perl-level code that could have done
2487 * anything, including closing the file or clearing this layer.
2488 * If so, free any lower layers that have already been
2489 * cleared, then return an error. */
2490 while (PerlIOValid(f) &&
2491 (PerlIOBase(f)->flags & PERLIO_F_CLEARED))
2493 const PerlIOl *l = *f;
2502 PerlIOUnix_oflags(const char *mode)
2505 if (*mode == IoTYPE_IMPLICIT || *mode == IoTYPE_NUMERIC)
2510 if (*++mode == '+') {
2517 oflags = O_CREAT | O_TRUNC;
2518 if (*++mode == '+') {
2527 oflags = O_CREAT | O_APPEND;
2528 if (*++mode == '+') {
2537 /* XXX TODO: PerlIO_open() test that exercises 'rb' and 'rt'. */
2539 /* Unless O_BINARY is different from O_TEXT, first bit-or:ing one
2540 * of them in, and then bit-and-masking the other them away, won't
2541 * have much of an effect. */
2544 #if O_TEXT != O_BINARY
2551 #if O_TEXT != O_BINARY
2553 oflags &= ~O_BINARY;
2559 /* bit-or:ing with zero O_BINARY would be useless. */
2561 * If neither "t" nor "b" was specified, open the file
2564 * Note that if something else than the zero byte was seen
2565 * here (e.g. bogus mode "rx"), just few lines later we will
2566 * set the errno and invalidate the flags.
2572 if (*mode || oflags == -1) {
2573 SETERRNO(EINVAL, LIB_INVARG);
2580 PerlIOUnix_fileno(pTHX_ PerlIO *f)
2582 PERL_UNUSED_CONTEXT;
2583 return PerlIOSelf(f, PerlIOUnix)->fd;
2587 PerlIOUnix_setfd(pTHX_ PerlIO *f, int fd, int imode)
2589 PerlIOUnix * const s = PerlIOSelf(f, PerlIOUnix);
2592 if (PerlLIO_fstat(fd, &st) == 0) {
2593 if (!S_ISREG(st.st_mode)) {
2594 DEBUG_i( PerlIO_debug("%d is not regular file\n",fd) );
2595 PerlIOBase(f)->flags |= PERLIO_F_NOTREG;
2598 DEBUG_i( PerlIO_debug("%d _is_ a regular file\n",fd) );
2604 PerlIOUnix_refcnt_inc(fd);
2605 PERL_UNUSED_CONTEXT;
2609 PerlIOUnix_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2611 IV code = PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
2612 if (*PerlIONext(f)) {
2613 /* We never call down so do any pending stuff now */
2614 PerlIO_flush(PerlIONext(f));
2616 * XXX could (or should) we retrieve the oflags from the open file
2617 * handle rather than believing the "mode" we are passed in? XXX
2618 * Should the value on NULL mode be 0 or -1?
2620 PerlIOUnix_setfd(aTHX_ f, PerlIO_fileno(PerlIONext(f)),
2621 mode ? PerlIOUnix_oflags(mode) : -1);
2623 PerlIOBase(f)->flags |= PERLIO_F_OPEN;
2629 PerlIOUnix_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
2631 const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2633 PERL_UNUSED_CONTEXT;
2634 if (PerlIOBase(f)->flags & PERLIO_F_NOTREG) {
2636 SETERRNO(ESPIPE, LIB_INVARG);
2638 SETERRNO(EINVAL, LIB_INVARG);
2642 new_loc = PerlLIO_lseek(fd, offset, whence);
2643 if (new_loc == (Off_t) - 1)
2645 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
2650 PerlIOUnix_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
2651 IV n, const char *mode, int fd, int imode,
2652 int perm, PerlIO *f, int narg, SV **args)
2654 bool known_cloexec = 0;
2655 if (PerlIOValid(f)) {
2656 if (PerlIOBase(f)->tab && PerlIOBase(f)->flags & PERLIO_F_OPEN)
2657 (*PerlIOBase(f)->tab->Close)(aTHX_ f);
2660 if (*mode == IoTYPE_NUMERIC)
2663 imode = PerlIOUnix_oflags(mode);
2665 perm = 0777; /* preserve RMS defaults, ACL inheritance, etc. */
2672 const char *path = SvPV_const(*args, len);
2673 if (!IS_SAFE_PATHNAME(path, len, "open"))
2675 fd = PerlLIO_open3_cloexec(path, imode, perm);
2681 setfd_inhexec_for_sysfd(fd);
2683 setfd_cloexec_or_inhexec_by_sysfdness(fd);
2684 if (*mode == IoTYPE_IMPLICIT)
2687 f = PerlIO_allocate(aTHX);
2689 if (!PerlIOValid(f)) {
2690 if (!(f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg))) {
2695 PerlIOUnix_setfd(aTHX_ f, fd, imode);
2696 PerlIOBase(f)->flags |= PERLIO_F_OPEN;
2697 if (*mode == IoTYPE_APPEND)
2698 PerlIOUnix_seek(aTHX_ f, 0, SEEK_END);
2705 * FIXME: pop layers ???
2713 PerlIOUnix_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2715 const PerlIOUnix * const os = PerlIOSelf(o, PerlIOUnix);
2717 if (flags & PERLIO_DUP_FD) {
2718 fd = PerlLIO_dup_cloexec(fd);
2720 setfd_inhexec_for_sysfd(fd);
2723 f = PerlIOBase_dup(aTHX_ f, o, param, flags);
2725 /* If all went well overwrite fd in dup'ed lay with the dup()'ed fd */
2726 PerlIOUnix_setfd(aTHX_ f, fd, os->oflags);
2736 PerlIOUnix_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
2739 if (PerlIO_lockcnt(f)) /* in use: abort ungracefully */
2741 fd = PerlIOSelf(f, PerlIOUnix)->fd;
2742 if (!(PerlIOBase(f)->flags & PERLIO_F_CANREAD) ||
2743 PerlIOBase(f)->flags & (PERLIO_F_EOF|PERLIO_F_ERROR)) {
2747 const SSize_t len = PerlLIO_read(fd, vbuf, count);
2748 if (len >= 0 || errno != EINTR) {
2750 if (errno != EAGAIN) {
2751 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2752 PerlIO_save_errno(f);
2755 else if (len == 0 && count != 0) {
2756 PerlIOBase(f)->flags |= PERLIO_F_EOF;
2762 if (PL_sig_pending && S_perlio_async_run(aTHX_ f))
2765 NOT_REACHED; /*NOTREACHED*/
2769 PerlIOUnix_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
2772 if (PerlIO_lockcnt(f)) /* in use: abort ungracefully */
2774 fd = PerlIOSelf(f, PerlIOUnix)->fd;
2776 const SSize_t len = PerlLIO_write(fd, vbuf, count);
2777 if (len >= 0 || errno != EINTR) {
2779 if (errno != EAGAIN) {
2780 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2781 PerlIO_save_errno(f);
2787 if (PL_sig_pending && S_perlio_async_run(aTHX_ f))
2790 NOT_REACHED; /*NOTREACHED*/
2794 PerlIOUnix_tell(pTHX_ PerlIO *f)
2796 PERL_UNUSED_CONTEXT;
2798 return PerlLIO_lseek(PerlIOSelf(f, PerlIOUnix)->fd, 0, SEEK_CUR);
2803 PerlIOUnix_close(pTHX_ PerlIO *f)
2805 const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2807 if (PerlIOBase(f)->flags & PERLIO_F_OPEN) {
2808 code = PerlIOBase_close(aTHX_ f);
2809 if (PerlIOUnix_refcnt_dec(fd) > 0) {
2810 PerlIOBase(f)->flags &= ~PERLIO_F_OPEN;
2815 SETERRNO(EBADF,SS_IVCHAN);
2818 while (PerlLIO_close(fd) != 0) {
2819 if (errno != EINTR) {
2824 if (PL_sig_pending && S_perlio_async_run(aTHX_ f))
2828 PerlIOBase(f)->flags &= ~PERLIO_F_OPEN;
2833 PERLIO_FUNCS_DECL(PerlIO_unix) = {
2834 sizeof(PerlIO_funcs),
2841 PerlIOBase_binmode, /* binmode */
2851 PerlIOBase_noop_ok, /* flush */
2852 PerlIOBase_noop_fail, /* fill */
2855 PerlIOBase_clearerr,
2856 PerlIOBase_setlinebuf,
2857 NULL, /* get_base */
2858 NULL, /* get_bufsiz */
2861 NULL, /* set_ptrcnt */
2864 /*--------------------------------------------------------------------------------------*/
2869 #if defined(VMS) && !defined(STDIO_BUFFER_WRITABLE)
2870 /* perl5.8 - This ensures the last minute VMS ungetc fix is not
2871 broken by the last second glibc 2.3 fix
2873 #define STDIO_BUFFER_WRITABLE
2878 struct _PerlIO base;
2879 FILE *stdio; /* The stream */
2883 PerlIOStdio_fileno(pTHX_ PerlIO *f)
2885 PERL_UNUSED_CONTEXT;
2887 if (PerlIOValid(f)) {
2888 FILE * const s = PerlIOSelf(f, PerlIOStdio)->stdio;
2890 return PerlSIO_fileno(s);
2897 PerlIOStdio_mode(const char *mode, char *tmode)
2899 char * const ret = tmode;
2905 #if defined(PERLIO_USING_CRLF) || defined(__CYGWIN__)
2913 PerlIOStdio_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2916 if (PerlIOValid(f) && PerlIOValid(n = PerlIONext(f))) {
2917 PerlIO_funcs * const toptab = PerlIOBase(n)->tab;
2918 if (toptab == tab) {
2919 /* Top is already stdio - pop self (duplicate) and use original */
2920 PerlIO_pop(aTHX_ f);
2923 const int fd = PerlIO_fileno(n);
2926 if (fd >= 0 && (stdio = PerlSIO_fdopen(fd,
2927 mode = PerlIOStdio_mode(mode, tmode)))) {
2928 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2929 /* We never call down so do any pending stuff now */
2930 PerlIO_flush(PerlIONext(f));
2931 return PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
2938 return PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
2943 PerlIO_importFILE(FILE *stdio, const char *mode)
2949 char filename[FILENAME_MAX];
2954 int fd0 = fileno(stdio);
2957 rc = fldata(stdio,filename,&fileinfo);
2961 if(fileinfo.__dsorgHFS){
2964 /*This MVS dataset , OK!*/
2969 if (!mode || !*mode) {
2970 /* We need to probe to see how we can open the stream
2971 so start with read/write and then try write and read
2972 we dup() so that we can fclose without loosing the fd.
2974 Note that the errno value set by a failing fdopen
2975 varies between stdio implementations.
2977 const int fd = PerlLIO_dup_cloexec(fd0);
2982 f2 = PerlSIO_fdopen(fd, (mode = "r+"));
2984 f2 = PerlSIO_fdopen(fd, (mode = "w"));
2987 f2 = PerlSIO_fdopen(fd, (mode = "r"));
2990 /* Don't seem to be able to open */
2996 if ((f = PerlIO_push(aTHX_(PerlIO_allocate(aTHX)), PERLIO_FUNCS_CAST(&PerlIO_stdio), mode, NULL))) {
2997 s = PerlIOSelf(f, PerlIOStdio);
2999 fd0 = fileno(stdio);
3001 PerlIOUnix_refcnt_inc(fd0);
3002 setfd_cloexec_or_inhexec_by_sysfdness(fd0);
3006 rc = fldata(stdio,filename,&fileinfo);
3008 PerlIOUnix_refcnt_inc(fd0);
3010 if(fileinfo.__dsorgHFS){
3011 PerlIOUnix_refcnt_inc(fd0);
3013 /*This MVS dataset , OK!*/
3022 PerlIOStdio_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
3023 IV n, const char *mode, int fd, int imode,
3024 int perm, PerlIO *f, int narg, SV **args)
3027 if (PerlIOValid(f)) {
3029 const char * const path = SvPV_const(*args, len);
3030 PerlIOStdio * const s = PerlIOSelf(f, PerlIOStdio);
3032 if (!IS_SAFE_PATHNAME(path, len, "open"))
3034 PerlIOUnix_refcnt_dec(fileno(s->stdio));
3035 stdio = PerlSIO_freopen(path, PerlIOStdio_mode(mode, tmode),
3041 PerlIOUnix_refcnt_inc(fd);
3042 setfd_cloexec_or_inhexec_by_sysfdness(fd);
3048 const char * const path = SvPV_const(*args, len);
3049 if (!IS_SAFE_PATHNAME(path, len, "open"))
3051 if (*mode == IoTYPE_NUMERIC) {
3053 fd = PerlLIO_open3_cloexec(path, imode, perm);
3057 bool appended = FALSE;
3059 /* Cygwin wants its 'b' early. */
3061 mode = PerlIOStdio_mode(mode, tmode);
3063 stdio = PerlSIO_fopen(path, mode);
3066 f = PerlIO_allocate(aTHX);
3069 mode = PerlIOStdio_mode(mode, tmode);
3070 f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg);
3072 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
3074 PerlIOUnix_refcnt_inc(fd);
3075 setfd_cloexec_or_inhexec_by_sysfdness(fd);
3077 PerlSIO_fclose(stdio);
3089 if (*mode == IoTYPE_IMPLICIT) {
3096 stdio = PerlSIO_stdin;
3099 stdio = PerlSIO_stdout;
3102 stdio = PerlSIO_stderr;
3107 stdio = PerlSIO_fdopen(fd, mode =
3108 PerlIOStdio_mode(mode, tmode));
3112 f = PerlIO_allocate(aTHX);
3114 if ((f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg))) {
3115 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
3117 PerlIOUnix_refcnt_inc(fd);
3118 setfd_cloexec_or_inhexec_by_sysfdness(fd);
3129 PerlIOStdio_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
3131 /* This assumes no layers underneath - which is what
3132 happens, but is not how I remember it. NI-S 2001/10/16
3134 if ((f = PerlIOBase_dup(aTHX_ f, o, param, flags))) {
3135 FILE *stdio = PerlIOSelf(o, PerlIOStdio)->stdio;
3136 const int fd = fileno(stdio);
3138 if (flags & PERLIO_DUP_FD) {
3139 const int dfd = PerlLIO_dup_cloexec(fileno(stdio));
3141 stdio = PerlSIO_fdopen(dfd, PerlIO_modestr(o,mode));
3146 /* FIXME: To avoid messy error recovery if dup fails
3147 re-use the existing stdio as though flag was not set
3151 stdio = PerlSIO_fdopen(fd, PerlIO_modestr(o,mode));
3153 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
3155 int fd = fileno(stdio);
3156 PerlIOUnix_refcnt_inc(fd);
3157 setfd_cloexec_or_inhexec_by_sysfdness(fd);
3164 PerlIOStdio_invalidate_fileno(pTHX_ FILE *f)
3166 PERL_UNUSED_CONTEXT;
3168 /* XXX this could use PerlIO_canset_fileno() and
3169 * PerlIO_set_fileno() support from Configure
3171 # if defined(HAS_FDCLOSE)
3172 return fdclose(f, NULL) == 0 ? 1 : 0;
3173 # elif defined(__UCLIBC__)
3174 /* uClibc must come before glibc because it defines __GLIBC__ as well. */
3177 # elif defined(__GLIBC__)
3178 /* There may be a better way for GLIBC:
3179 - libio.h defines a flag to not close() on cleanup
3183 # elif defined(__sun)
3186 # elif defined(__hpux)
3190 /* Next one ->_file seems to be a reasonable fallback, i.e. if
3191 your platform does not have special entry try this one.
3192 [For OSF only have confirmation for Tru64 (alpha)
3193 but assume other OSFs will be similar.]
3195 # elif defined(_AIX) || defined(__osf__) || defined(__irix__)
3198 # elif defined(__FreeBSD__)
3199 /* There may be a better way on FreeBSD:
3200 - we could insert a dummy func in the _close function entry
3201 f->_close = (int (*)(void *)) dummy_close;
3205 # elif defined(__OpenBSD__)
3206 /* There may be a better way on OpenBSD:
3207 - we could insert a dummy func in the _close function entry
3208 f->_close = (int (*)(void *)) dummy_close;
3212 # elif defined(__EMX__)
3213 /* f->_flags &= ~_IOOPEN; */ /* Will leak stream->_buffer */
3216 # elif defined(__CYGWIN__)
3217 /* There may be a better way on CYGWIN:
3218 - we could insert a dummy func in the _close function entry
3219 f->_close = (int (*)(void *)) dummy_close;
3223 # elif defined(WIN32)
3224 PERLIO_FILE_file(f) = -1;
3228 /* Sarathy's code did this - we fall back to a dup/dup2 hack
3229 (which isn't thread safe) instead
3231 # error "Don't know how to set FILE.fileno on your platform"
3239 PerlIOStdio_close(pTHX_ PerlIO *f)
3241 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3247 const int fd = fileno(stdio);
3254 #ifdef SOCKS5_VERSION_NAME
3255 /* Socks lib overrides close() but stdio isn't linked to
3256 that library (though we are) - so we must call close()
3257 on sockets on stdio's behalf.
3260 Sock_size_t optlen = sizeof(int);
3261 if (getsockopt(fd, SOL_SOCKET, SO_TYPE, (void *) &optval, &optlen) == 0)
3264 /* Test for -1, as *BSD stdio (at least) on fclose sets the FILE* such
3265 that a subsequent fileno() on it returns -1. Don't want to croak()
3266 from within PerlIOUnix_refcnt_dec() if some buggy caller code is
3267 trying to close an already closed handle which somehow it still has
3268 a reference to. (via.xs, I'm looking at you). */
3269 if (fd != -1 && PerlIOUnix_refcnt_dec(fd) > 0) {
3270 /* File descriptor still in use */
3274 /* For STD* handles, don't close stdio, since we shared the FILE *, too. */
3275 if (stdio == stdin) /* Some stdios are buggy fflush-ing inputs */
3277 if (stdio == stdout || stdio == stderr)
3278 return PerlIO_flush(f);
3280 MUTEX_LOCK(&PL_perlio_mutex);
3281 /* Right. We need a mutex here because for a brief while we
3282 will have the situation that fd is actually closed. Hence if
3283 a second thread were to get into this block, its dup() would
3284 likely return our fd as its dupfd. (after all, it is closed)
3285 Then if we get to the dup2() first, we blat the fd back
3286 (messing up its temporary as a side effect) only for it to
3287 then close its dupfd (== our fd) in its close(dupfd) */
3289 /* There is, of course, a race condition, that any other thread
3290 trying to input/output/whatever on this fd will be stuffed
3291 for the duration of this little manoeuvrer. Perhaps we
3292 should hold an IO mutex for the duration of every IO
3293 operation if we know that invalidate doesn't work on this
3294 platform, but that would suck, and could kill performance.
3296 Except that correctness trumps speed.
3297 Advice from klortho #11912. */
3299 /* Tricky - must fclose(stdio) to free memory but not close(fd)
3300 Use Sarathy's trick from maint-5.6 to invalidate the
3301 fileno slot of the FILE *
3303 result = PerlIO_flush(f);
3305 invalidate = PerlIOStdio_invalidate_fileno(aTHX_ stdio);
3307 dupfd = PerlLIO_dup_cloexec(fd);
3310 /* Oh cXap. This isn't going to go well. Not sure if we can
3311 recover from here, or if closing this particular FILE *
3312 is a good idea now. */
3317 SAVE_ERRNO; /* This is here only to silence compiler warnings */
3319 result = PerlSIO_fclose(stdio);
3320 /* We treat error from stdio as success if we invalidated
3321 errno may NOT be expected EBADF
3323 if (invalidate && result != 0) {
3327 #ifdef SOCKS5_VERSION_NAME
3328 /* in SOCKS' case, let close() determine return value */
3332 PerlLIO_dup2_cloexec(dupfd, fd);
3333 setfd_inhexec_for_sysfd(fd);
3334 PerlLIO_close(dupfd);
3336 MUTEX_UNLOCK(&PL_perlio_mutex);
3342 PerlIOStdio_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
3346 if (PerlIO_lockcnt(f)) /* in use: abort ungracefully */
3348 s = PerlIOSelf(f, PerlIOStdio)->stdio;
3351 STDCHAR *buf = (STDCHAR *) vbuf;
3353 * Perl is expecting PerlIO_getc() to fill the buffer Linux's
3354 * stdio does not do that for fread()
3356 const int ch = PerlSIO_fgetc(s);
3363 got = PerlSIO_fread(vbuf, 1, count, s);
3364 if (got == 0 && PerlSIO_ferror(s))
3366 if (got >= 0 || errno != EINTR)
3368 if (PL_sig_pending && S_perlio_async_run(aTHX_ f))
3370 SETERRNO(0,0); /* just in case */
3373 /* Under some circumstances IRIX stdio fgetc() and fread()
3374 * set the errno to ENOENT, which makes no sense according
3375 * to either IRIX or POSIX. [rt.perl.org #123977] */
3376 if (errno == ENOENT) SETERRNO(0,0);
3382 PerlIOStdio_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3385 FILE * const s = PerlIOSelf(f, PerlIOStdio)->stdio;
3387 #ifdef STDIO_BUFFER_WRITABLE
3388 if (PerlIO_fast_gets(f) && PerlIO_has_base(f)) {
3389 STDCHAR *buf = ((STDCHAR *) vbuf) + count;
3390 STDCHAR *base = PerlIO_get_base(f);
3391 SSize_t cnt = PerlIO_get_cnt(f);
3392 STDCHAR *ptr = PerlIO_get_ptr(f);
3393 SSize_t avail = ptr - base;
3395 if (avail > count) {
3399 Move(buf-avail,ptr,avail,STDCHAR);
3402 PerlIO_set_ptrcnt(f,ptr,cnt+avail);
3403 if (PerlSIO_feof(s) && unread >= 0)
3404 PerlSIO_clearerr(s);
3409 if (PerlIO_has_cntptr(f)) {
3410 /* We can get pointer to buffer but not its base
3411 Do ungetc() but check chars are ending up in the
3414 STDCHAR *eptr = (STDCHAR*)PerlSIO_get_ptr(s);
3415 STDCHAR *buf = ((STDCHAR *) vbuf) + count;
3417 const int ch = *--buf & 0xFF;
3418 if (ungetc(ch,s) != ch) {
3419 /* ungetc did not work */
3422 if ((STDCHAR*)PerlSIO_get_ptr(s) != --eptr || ((*eptr & 0xFF) != ch)) {
3423 /* Did not change pointer as expected */
3424 if (fgetc(s) != EOF) /* get char back again */
3434 unread += PerlIOBase_unread(aTHX_ f, vbuf, count);
3440 PerlIOStdio_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3443 if (PerlIO_lockcnt(f)) /* in use: abort ungracefully */
3446 got = PerlSIO_fwrite(vbuf, 1, count,
3447 PerlIOSelf(f, PerlIOStdio)->stdio);
3448 if (got >= 0 || errno != EINTR)
3450 if (PL_sig_pending && S_perlio_async_run(aTHX_ f))
3452 SETERRNO(0,0); /* just in case */
3458 PerlIOStdio_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3460 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3461 PERL_UNUSED_CONTEXT;
3463 return PerlSIO_fseek(stdio, offset, whence);
3467 PerlIOStdio_tell(pTHX_ PerlIO *f)
3469 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3470 PERL_UNUSED_CONTEXT;
3472 return PerlSIO_ftell(stdio);
3476 PerlIOStdio_flush(pTHX_ PerlIO *f)
3478 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3479 PERL_UNUSED_CONTEXT;
3481 if (PerlIOBase(f)->flags & PERLIO_F_CANWRITE) {
3482 return PerlSIO_fflush(stdio);
3488 * FIXME: This discards ungetc() and pre-read stuff which is not
3489 * right if this is just a "sync" from a layer above Suspect right
3490 * design is to do _this_ but not have layer above flush this
3491 * layer read-to-read
3494 * Not writeable - sync by attempting a seek
3497 if (PerlSIO_fseek(stdio, (Off_t) 0, SEEK_CUR) != 0)
3505 PerlIOStdio_eof(pTHX_ PerlIO *f)
3507 PERL_UNUSED_CONTEXT;
3509 return PerlSIO_feof(PerlIOSelf(f, PerlIOStdio)->stdio);
3513 PerlIOStdio_error(pTHX_ PerlIO *f)
3515 PERL_UNUSED_CONTEXT;
3517 return PerlSIO_ferror(PerlIOSelf(f, PerlIOStdio)->stdio);
3521 PerlIOStdio_clearerr(pTHX_ PerlIO *f)
3523 PERL_UNUSED_CONTEXT;
3525 PerlSIO_clearerr(PerlIOSelf(f, PerlIOStdio)->stdio);
3529 PerlIOStdio_setlinebuf(pTHX_ PerlIO *f)
3531 PERL_UNUSED_CONTEXT;
3533 #ifdef HAS_SETLINEBUF
3534 PerlSIO_setlinebuf(PerlIOSelf(f, PerlIOStdio)->stdio);
3536 PerlSIO_setvbuf(PerlIOSelf(f, PerlIOStdio)->stdio, NULL, _IOLBF, 0);
3542 PerlIOStdio_get_base(pTHX_ PerlIO *f)
3544 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3545 PERL_UNUSED_CONTEXT;
3546 return (STDCHAR*)PerlSIO_get_base(stdio);
3550 PerlIOStdio_get_bufsiz(pTHX_ PerlIO *f)
3552 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3553 PERL_UNUSED_CONTEXT;
3554 return PerlSIO_get_bufsiz(stdio);
3558 #ifdef USE_STDIO_PTR
3560 PerlIOStdio_get_ptr(pTHX_ PerlIO *f)
3562 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3563 PERL_UNUSED_CONTEXT;
3564 return (STDCHAR*)PerlSIO_get_ptr(stdio);
3568 PerlIOStdio_get_cnt(pTHX_ PerlIO *f)
3570 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3571 PERL_UNUSED_CONTEXT;
3572 return PerlSIO_get_cnt(stdio);
3576 PerlIOStdio_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
3578 FILE * const stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3579 PERL_UNUSED_CONTEXT;
3581 #ifdef STDIO_PTR_LVALUE
3582 /* This is a long-standing infamous mess. The root of the
3583 * problem is that one cannot know the signedness of char, and
3584 * more precisely the signedness of FILE._ptr. The following
3585 * things have been tried, and they have all failed (across
3586 * different compilers (remember that core needs to to build
3587 * also with c++) and compiler options:
3589 * - casting the RHS to (void*) -- works in *some* places
3590 * - casting the LHS to (void*) -- totally unportable
3592 * So let's try silencing the warning at least for gcc. */
3593 GCC_DIAG_IGNORE_STMT(-Wpointer-sign);
3594 PerlSIO_set_ptr(stdio, ptr); /* LHS STDCHAR* cast non-portable */
3595 GCC_DIAG_RESTORE_STMT;
3596 #ifdef STDIO_PTR_LVAL_SETS_CNT
3597 assert(PerlSIO_get_cnt(stdio) == (cnt));
3599 #if (!defined(STDIO_PTR_LVAL_NOCHANGE_CNT))
3601 * Setting ptr _does_ change cnt - we are done
3605 #else /* STDIO_PTR_LVALUE */
3607 #endif /* STDIO_PTR_LVALUE */
3610 * Now (or only) set cnt
3612 #ifdef STDIO_CNT_LVALUE
3613 PerlSIO_set_cnt(stdio, cnt);
3614 #elif (defined(STDIO_PTR_LVALUE) && defined(STDIO_PTR_LVAL_SETS_CNT))
3615 PerlSIO_set_ptr(stdio,
3616 PerlSIO_get_ptr(stdio) + (PerlSIO_get_cnt(stdio) -
3618 #else /* STDIO_PTR_LVAL_SETS_CNT */
3620 #endif /* STDIO_CNT_LVALUE */
3627 PerlIOStdio_fill(pTHX_ PerlIO *f)
3631 PERL_UNUSED_CONTEXT;
3632 if (PerlIO_lockcnt(f)) /* in use: abort ungracefully */
3634 stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3637 * fflush()ing read-only streams can cause trouble on some stdio-s
3639 if ((PerlIOBase(f)->flags & PERLIO_F_CANWRITE)) {
3640 if (PerlSIO_fflush(stdio) != 0)
3644 c = PerlSIO_fgetc(stdio);
3647 if (! PerlSIO_ferror(stdio) || errno != EINTR)
3649 if (PL_sig_pending && S_perlio_async_run(aTHX_ f))
3654 #if (defined(STDIO_PTR_LVALUE) && (defined(STDIO_CNT_LVALUE) || defined(STDIO_PTR_LVAL_SETS_CNT)))
3656 #ifdef STDIO_BUFFER_WRITABLE
3657 if (PerlIO_fast_gets(f) && PerlIO_has_base(f)) {
3658 /* Fake ungetc() to the real buffer in case system's ungetc
3661 STDCHAR *base = (STDCHAR*)PerlSIO_get_base(stdio);
3662 SSize_t cnt = PerlSIO_get_cnt(stdio);
3663 STDCHAR *ptr = (STDCHAR*)PerlSIO_get_ptr(stdio);
3664 if (ptr == base+1) {
3665 *--ptr = (STDCHAR) c;
3666 PerlIOStdio_set_ptrcnt(aTHX_ f,ptr,cnt+1);
3667 if (PerlSIO_feof(stdio))
3668 PerlSIO_clearerr(stdio);
3674 if (PerlIO_has_cntptr(f)) {
3676 if (PerlIOStdio_unread(aTHX_ f,&ch,1) == 1) {
3682 /* If buffer snoop scheme above fails fall back to
3685 if (PerlSIO_ungetc(c, stdio) != c)
3693 PERLIO_FUNCS_DECL(PerlIO_stdio) = {
3694 sizeof(PerlIO_funcs),
3696 sizeof(PerlIOStdio),
3697 PERLIO_K_BUFFERED|PERLIO_K_RAW,
3701 PerlIOBase_binmode, /* binmode */
3715 PerlIOStdio_clearerr,
3716 PerlIOStdio_setlinebuf,
3718 PerlIOStdio_get_base,
3719 PerlIOStdio_get_bufsiz,
3724 #ifdef USE_STDIO_PTR
3725 PerlIOStdio_get_ptr,
3726 PerlIOStdio_get_cnt,
3727 # if defined(HAS_FAST_STDIO) && defined(USE_FAST_STDIO)
3728 PerlIOStdio_set_ptrcnt,
3731 # endif /* HAS_FAST_STDIO && USE_FAST_STDIO */
3736 #endif /* USE_STDIO_PTR */
3739 /* Note that calls to PerlIO_exportFILE() are reversed using
3740 * PerlIO_releaseFILE(), not importFILE. */
3742 PerlIO_exportFILE(PerlIO * f, const char *mode)
3746 if (PerlIOValid(f)) {
3748 int fd = PerlIO_fileno(f);
3753 if (!mode || !*mode) {
3754 mode = PerlIO_modestr(f, buf);
3756 stdio = PerlSIO_fdopen(PerlIO_fileno(f), mode);
3760 /* De-link any lower layers so new :stdio sticks */
3762 if ((f2 = PerlIO_push(aTHX_ f, PERLIO_FUNCS_CAST(&PerlIO_stdio), buf, NULL))) {
3763 PerlIOStdio *s = PerlIOSelf((f = f2), PerlIOStdio);
3765 PerlIOUnix_refcnt_inc(fileno(stdio));
3766 /* Link previous lower layers under new one */
3770 /* restore layers list */
3780 PerlIO_findFILE(PerlIO *f)
3785 if (l->tab == &PerlIO_stdio) {
3786 PerlIOStdio *s = PerlIOSelf(&l, PerlIOStdio);
3789 l = *PerlIONext(&l);
3791 /* Uses fallback "mode" via PerlIO_modestr() in PerlIO_exportFILE */
3792 /* However, we're not really exporting a FILE * to someone else (who
3793 becomes responsible for closing it, or calling PerlIO_releaseFILE())
3794 So we need to undo its reference count increase on the underlying file
3795 descriptor. We have to do this, because if the loop above returns you
3796 the FILE *, then *it* didn't increase any reference count. So there's
3797 only one way to be consistent. */
3798 stdio = PerlIO_exportFILE(f, NULL);
3800 const int fd = fileno(stdio);
3802 PerlIOUnix_refcnt_dec(fd);
3807 /* Use this to reverse PerlIO_exportFILE calls. */
3809 PerlIO_releaseFILE(PerlIO *p, FILE *f)
3813 if (l->tab == &PerlIO_stdio) {
3814 PerlIOStdio *s = PerlIOSelf(&l, PerlIOStdio);
3815 if (s->stdio == f) { /* not in a loop */
3816 const int fd = fileno(f);
3818 PerlIOUnix_refcnt_dec(fd);
3821 PerlIO_pop(aTHX_ p);
3831 /*--------------------------------------------------------------------------------------*/
3833 * perlio buffer layer
3837 PerlIOBuf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
3839 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3840 const int fd = PerlIO_fileno(f);
3841 if (fd >= 0 && PerlLIO_isatty(fd)) {
3842 PerlIOBase(f)->flags |= PERLIO_F_LINEBUF | PERLIO_F_TTY;
3844 if (*PerlIONext(f)) {
3845 const Off_t posn = PerlIO_tell(PerlIONext(f));
3846 if (posn != (Off_t) - 1) {
3850 return PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
3854 PerlIOBuf_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
3855 IV n, const char *mode, int fd, int imode, int perm,
3856 PerlIO *f, int narg, SV **args)
3858 if (PerlIOValid(f)) {
3859 PerlIO *next = PerlIONext(f);
3861 PerlIO_layer_fetch(aTHX_ layers, n - 1, PerlIOBase(next)->tab);
3862 if (tab && tab->Open)
3864 (*tab->Open)(aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
3866 if (!next || (*PerlIOBase(f)->tab->Pushed) (aTHX_ f, mode, PerlIOArg, self) != 0) {
3871 PerlIO_funcs *tab = PerlIO_layer_fetch(aTHX_ layers, n - 1, PerlIO_default_btm());
3873 if (*mode == IoTYPE_IMPLICIT) {
3879 if (tab && tab->Open)
3880 f = (*tab->Open)(aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
3883 SETERRNO(EINVAL, LIB_INVARG);
3885 if (PerlIO_push(aTHX_ f, self, mode, PerlIOArg) == 0) {
3887 * if push fails during open, open fails. close will pop us.
3892 fd = PerlIO_fileno(f);
3893 if (init && fd == 2) {
3895 * Initial stderr is unbuffered
3897 PerlIOBase(f)->flags |= PERLIO_F_UNBUF;
3899 #ifdef PERLIO_USING_CRLF
3900 # ifdef PERLIO_IS_BINMODE_FD
3901 if (PERLIO_IS_BINMODE_FD(fd))
3902 PerlIO_binmode(aTHX_ f, '<'/*not used*/, O_BINARY, NULL);
3906 * do something about failing setmode()? --jhi
3908 PerlLIO_setmode(fd, O_BINARY);
3911 /* Enable line buffering with record-oriented regular files
3912 * so we don't introduce an extraneous record boundary when
3913 * the buffer fills up.
3915 if (PerlIOBase(f)->flags & PERLIO_F_CANWRITE) {
3917 if (PerlLIO_fstat(fd, &st) == 0
3918 && S_ISREG(st.st_mode)
3919 && (st.st_fab_rfm == FAB$C_VAR
3920 || st.st_fab_rfm == FAB$C_VFC)) {
3921 PerlIOBase(f)->flags |= PERLIO_F_LINEBUF;
3932 * This "flush" is akin to sfio's sync in that it handles files in either
3933 * read or write state. For write state, we put the postponed data through
3934 * the next layers. For read state, we seek() the next layers to the
3935 * offset given by current position in the buffer, and discard the buffer
3936 * state (XXXX supposed to be for seek()able buffers only, but now it is done
3937 * in any case?). Then the pass the stick further in chain.
3940 PerlIOBuf_flush(pTHX_ PerlIO *f)
3942 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3944 PerlIO *n = PerlIONext(f);
3945 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF) {
3947 * write() the buffer
3949 const STDCHAR *buf = b->buf;
3950 const STDCHAR *p = buf;
3951 while (p < b->ptr) {
3952 SSize_t count = PerlIO_write(n, p, b->ptr - p);
3956 else if (count < 0 || PerlIO_error(n)) {
3957 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
3958 PerlIO_save_errno(f);
3963 b->posn += (p - buf);
3965 else if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3966 STDCHAR *buf = PerlIO_get_base(f);
3968 * Note position change
3970 b->posn += (b->ptr - buf);
3971 if (b->ptr < b->end) {
3972 /* We did not consume all of it - try and seek downstream to
3973 our logical position
3975 if (PerlIOValid(n) && PerlIO_seek(n, b->posn, SEEK_SET) == 0) {
3976 /* Reload n as some layers may pop themselves on seek */
3977 b->posn = PerlIO_tell(n = PerlIONext(f));
3980 /* Seek failed (e.g. pipe or tty). Do NOT clear buffer or pre-read
3981 data is lost for good - so return saying "ok" having undone
3984 b->posn -= (b->ptr - buf);
3989 b->ptr = b->end = b->buf;
3990 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3991 /* We check for Valid because of dubious decision to make PerlIO_flush(NULL) flush all */
3992 if (PerlIOValid(n) && PerlIO_flush(n) != 0)
3997 /* This discards the content of the buffer after b->ptr, and rereads
3998 * the buffer from the position off in the layer downstream; here off
3999 * is at offset corresponding to b->ptr - b->buf.
4002 PerlIOBuf_fill(pTHX_ PerlIO *f)
4004 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4005 PerlIO *n = PerlIONext(f);
4008 * Down-stream flush is defined not to loose read data so is harmless.
4009 * we would not normally be fill'ing if there was data left in anycase.
4011 if (PerlIO_flush(f) != 0) /* XXXX Check that its seek() succeeded?! */
4013 if (PerlIOBase(f)->flags & PERLIO_F_TTY)
4014 PerlIOBase_flush_linebuf(aTHX);
4017 PerlIO_get_base(f); /* allocate via vtable */
4019 assert(b->buf); /* The b->buf does get allocated via the vtable system. */
4021 b->ptr = b->end = b->buf;
4023 if (!PerlIOValid(n)) {
4024 PerlIOBase(f)->flags |= PERLIO_F_EOF;
4028 if (PerlIO_fast_gets(n)) {
4030 * Layer below is also buffered. We do _NOT_ want to call its
4031 * ->Read() because that will loop till it gets what we asked for
4032 * which may hang on a pipe etc. Instead take anything it has to
4033 * hand, or ask it to fill _once_.
4035 avail = PerlIO_get_cnt(n);
4037 avail = PerlIO_fill(n);
4039 avail = PerlIO_get_cnt(n);
4041 if (!PerlIO_error(n) && PerlIO_eof(n))
4046 STDCHAR *ptr = PerlIO_get_ptr(n);
4047 const SSize_t cnt = avail;
4048 if (avail > (SSize_t)b->bufsiz)
4050 Copy(ptr, b->buf, avail, STDCHAR);
4051 PerlIO_set_ptrcnt(n, ptr + avail, cnt - avail);
4055 avail = PerlIO_read(n, b->ptr, b->bufsiz);
4059 PerlIOBase(f)->flags |= PERLIO_F_EOF;
4062 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
4063 PerlIO_save_errno(f);
4067 b->end = b->buf + avail;
4068 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4073 PerlIOBuf_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
4075 if (PerlIOValid(f)) {
4076 const PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4079 return PerlIOBase_read(aTHX_ f, vbuf, count);
4085 PerlIOBuf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4087 const STDCHAR *buf = (const STDCHAR *) vbuf + count;
4088 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4091 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
4096 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
4098 * Buffer is already a read buffer, we can overwrite any chars
4099 * which have been read back to buffer start
4101 avail = (b->ptr - b->buf);
4105 * Buffer is idle, set it up so whole buffer is available for
4109 b->end = b->buf + avail;
4111 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4113 * Buffer extends _back_ from where we are now
4115 b->posn -= b->bufsiz;
4117 if ((SSize_t) count >= 0 && avail > (SSize_t) count) {
4119 * If we have space for more than count, just move count
4127 * In simple stdio-like ungetc() case chars will be already
4130 if (buf != b->ptr) {
4131 Copy(buf, b->ptr, avail, STDCHAR);
4135 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
4139 unread += PerlIOBase_unread(aTHX_ f, vbuf, count);
4145 PerlIOBuf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4147 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4148 const STDCHAR *buf = (const STDCHAR *) vbuf;
4149 const STDCHAR *flushptr = buf;
4153 if (!(PerlIOBase(f)->flags & PERLIO_F_CANWRITE))
4155 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
4156 if (PerlIO_flush(f) != 0) {
4160 if (PerlIOBase(f)->flags & PERLIO_F_LINEBUF) {
4161 flushptr = buf + count;
4162 while (flushptr > buf && *(flushptr - 1) != '\n')
4166 SSize_t avail = b->bufsiz - (b->ptr - b->buf);
4167 if ((SSize_t) count >= 0 && (SSize_t) count < avail)
4169 if (flushptr > buf && flushptr <= buf + avail)
4170 avail = flushptr - buf;
4171 PerlIOBase(f)->flags |= PERLIO_F_WRBUF;
4173 Copy(buf, b->ptr, avail, STDCHAR);
4178 if (buf == flushptr)
4181 if (b->ptr >= (b->buf + b->bufsiz))
4182 if (PerlIO_flush(f) == -1)
4185 if (PerlIOBase(f)->flags & PERLIO_F_UNBUF)
4191 PerlIOBuf_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
4194 if ((code = PerlIO_flush(f)) == 0) {
4195 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
4196 code = PerlIO_seek(PerlIONext(f), offset, whence);
4198 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4199 b->posn = PerlIO_tell(PerlIONext(f));
4206 PerlIOBuf_tell(pTHX_ PerlIO *f)
4208 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4210 * b->posn is file position where b->buf was read, or will be written
4212 Off_t posn = b->posn;
4213 if ((PerlIOBase(f)->flags & PERLIO_F_APPEND) &&
4214 (PerlIOBase(f)->flags & PERLIO_F_WRBUF)) {
4216 /* As O_APPEND files are normally shared in some sense it is better
4221 /* when file is NOT shared then this is sufficient */
4222 PerlIO_seek(PerlIONext(f),0, SEEK_END);
4224 posn = b->posn = PerlIO_tell(PerlIONext(f));
4228 * If buffer is valid adjust position by amount in buffer
4230 posn += (b->ptr - b->buf);
4236 PerlIOBuf_popped(pTHX_ PerlIO *f)
4238 const IV code = PerlIOBase_popped(aTHX_ f);
4239 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4240 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
4243 b->ptr = b->end = b->buf = NULL;
4244 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
4249 PerlIOBuf_close(pTHX_ PerlIO *f)
4251 const IV code = PerlIOBase_close(aTHX_ f);
4252 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4253 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
4256 b->ptr = b->end = b->buf = NULL;
4257 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
4262 PerlIOBuf_get_ptr(pTHX_ PerlIO *f)
4264 const PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4271 PerlIOBuf_get_cnt(pTHX_ PerlIO *f)
4273 const PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4276 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF)
4277 return (b->end - b->ptr);
4282 PerlIOBuf_get_base(pTHX_ PerlIO *f)
4284 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4285 PERL_UNUSED_CONTEXT;
4289 b->bufsiz = PERLIOBUF_DEFAULT_BUFSIZ;
4290 Newx(b->buf,b->bufsiz, STDCHAR);
4292 b->buf = (STDCHAR *) & b->oneword;
4293 b->bufsiz = sizeof(b->oneword);
4295 b->end = b->ptr = b->buf;
4301 PerlIOBuf_bufsiz(pTHX_ PerlIO *f)
4303 const PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4306 return (b->end - b->buf);
4310 PerlIOBuf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
4312 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4314 PERL_UNUSED_ARG(cnt);
4319 assert(PerlIO_get_cnt(f) == cnt);
4320 assert(b->ptr >= b->buf);
4321 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4325 PerlIOBuf_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
4327 return PerlIOBase_dup(aTHX_ f, o, param, flags);
4332 PERLIO_FUNCS_DECL(PerlIO_perlio) = {
4333 sizeof(PerlIO_funcs),
4336 PERLIO_K_BUFFERED|PERLIO_K_RAW,
4340 PerlIOBase_binmode, /* binmode */
4354 PerlIOBase_clearerr,
4355 PerlIOBase_setlinebuf,
4360 PerlIOBuf_set_ptrcnt,
4363 /*--------------------------------------------------------------------------------------*/
4365 * Temp layer to hold unread chars when cannot do it any other way
4369 PerlIOPending_fill(pTHX_ PerlIO *f)
4372 * Should never happen
4379 PerlIOPending_close(pTHX_ PerlIO *f)
4382 * A tad tricky - flush pops us, then we close new top
4385 return PerlIO_close(f);
4389 PerlIOPending_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
4392 * A tad tricky - flush pops us, then we seek new top
4395 return PerlIO_seek(f, offset, whence);
4400 PerlIOPending_flush(pTHX_ PerlIO *f)
4402 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4403 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
4407 PerlIO_pop(aTHX_ f);
4412 PerlIOPending_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
4418 PerlIOBuf_set_ptrcnt(aTHX_ f, ptr, cnt);
4423 PerlIOPending_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
4425 const IV code = PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
4426 PerlIOl * const l = PerlIOBase(f);
4428 * Our PerlIO_fast_gets must match what we are pushed on, or sv_gets()
4429 * etc. get muddled when it changes mid-string when we auto-pop.
4431 l->flags = (l->flags & ~(PERLIO_F_FASTGETS | PERLIO_F_UTF8)) |
4432 (PerlIOBase(PerlIONext(f))->
4433 flags & (PERLIO_F_FASTGETS | PERLIO_F_UTF8));
4438 PerlIOPending_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
4440 SSize_t avail = PerlIO_get_cnt(f);
4442 if ((SSize_t) count >= 0 && (SSize_t)count < avail)
4445 got = PerlIOBuf_read(aTHX_ f, vbuf, avail);
4446 if (got >= 0 && got < (SSize_t)count) {
4447 const SSize_t more =
4448 PerlIO_read(f, ((STDCHAR *) vbuf) + got, count - got);
4449 if (more >= 0 || got == 0)
4455 PERLIO_FUNCS_DECL(PerlIO_pending) = {
4456 sizeof(PerlIO_funcs),
4459 PERLIO_K_BUFFERED|PERLIO_K_RAW, /* not sure about RAW here */
4460 PerlIOPending_pushed,
4463 PerlIOBase_binmode, /* binmode */
4472 PerlIOPending_close,
4473 PerlIOPending_flush,
4477 PerlIOBase_clearerr,
4478 PerlIOBase_setlinebuf,
4483 PerlIOPending_set_ptrcnt,
4488 /*--------------------------------------------------------------------------------------*/
4490 * crlf - translation On read translate CR,LF to "\n" we do this by
4491 * overriding ptr/cnt entries to hand back a line at a time and keeping a
4492 * record of which nl we "lied" about. On write translate "\n" to CR,LF
4494 * c->nl points on the first byte of CR LF pair when it is temporarily
4495 * replaced by LF, or to the last CR of the buffer. In the former case
4496 * the caller thinks that the buffer ends at c->nl + 1, in the latter
4497 * that it ends at c->nl; these two cases can be distinguished by
4498 * *c->nl. c->nl is set during _getcnt() call, and unset during
4499 * _unread() and _flush() calls.
4500 * It only matters for read operations.
4504 PerlIOBuf base; /* PerlIOBuf stuff */
4505 STDCHAR *nl; /* Position of crlf we "lied" about in the
4509 /* Inherit the PERLIO_F_UTF8 flag from previous layer.
4510 * Otherwise the :crlf layer would always revert back to
4514 S_inherit_utf8_flag(PerlIO *f)
4516 PerlIO *g = PerlIONext(f);
4517 if (PerlIOValid(g)) {
4518 if (PerlIOBase(g)->flags & PERLIO_F_UTF8) {
4519 PerlIOBase(f)->flags |= PERLIO_F_UTF8;
4525 PerlIOCrlf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
4528 PerlIOBase(f)->flags |= PERLIO_F_CRLF;
4529 code = PerlIOBuf_pushed(aTHX_ f, mode, arg, tab);
4532 PerlIO_debug("PerlIOCrlf_pushed f=%p %s %s fl=%08" UVxf "\n",
4533 (void*)f, PerlIOBase(f)->tab->name, (mode) ? mode : "(Null)",
4534 PerlIOBase(f)->flags);
4538 /* If the old top layer is a CRLF layer, reactivate it (if
4539 * necessary) and remove this new layer from the stack */
4540 PerlIO *g = PerlIONext(f);
4541 if (PerlIOValid(g)) {
4542 PerlIOl *b = PerlIOBase(g);
4543 if (b && b->tab == &PerlIO_crlf) {
4544 if (!(b->flags & PERLIO_F_CRLF))
4545 b->flags |= PERLIO_F_CRLF;
4546 S_inherit_utf8_flag(g);
4547 PerlIO_pop(aTHX_ f);
4552 S_inherit_utf8_flag(f);
4558 PerlIOCrlf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4560 PerlIOCrlf * const c = PerlIOSelf(f, PerlIOCrlf);
4561 if (c->nl) { /* XXXX Shouldn't it be done only if b->ptr > c->nl? */
4562 *(c->nl) = NATIVE_0xd;
4565 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF))
4566 return PerlIOBuf_unread(aTHX_ f, vbuf, count);
4568 const STDCHAR *buf = (const STDCHAR *) vbuf + count;
4569 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4571 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
4576 if (!(PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4577 b->end = b->ptr = b->buf + b->bufsiz;
4578 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4579 b->posn -= b->bufsiz;
4581 while (count > 0 && b->ptr > b->buf) {
4582 const int ch = *--buf;
4584 if (b->ptr - 2 >= b->buf) {
4585 *--(b->ptr) = NATIVE_0xa;
4586 *--(b->ptr) = NATIVE_0xd;
4591 /* If b->ptr - 1 == b->buf, we are undoing reading 0xa */
4592 *--(b->ptr) = NATIVE_0xa; /* Works even if 0xa ==
4606 unread += PerlIOBase_unread(aTHX_ f, (const STDCHAR *) vbuf + unread, count);
4611 /* XXXX This code assumes that buffer size >=2, but does not check it... */
4613 PerlIOCrlf_get_cnt(pTHX_ PerlIO *f)
4615 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4618 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
4619 PerlIOCrlf * const c = PerlIOSelf(f, PerlIOCrlf);
4620 if ((PerlIOBase(f)->flags & PERLIO_F_CRLF) && (!c->nl || *c->nl == NATIVE_0xd)) {
4621 STDCHAR *nl = (c->nl) ? c->nl : b->ptr;
4623 while (nl < b->end && *nl != NATIVE_0xd)
4625 if (nl < b->end && *nl == NATIVE_0xd) {
4627 if (nl + 1 < b->end) {
4628 if (nl[1] == NATIVE_0xa) {
4634 * Not CR,LF but just CR
4642 * Blast - found CR as last char in buffer
4647 * They may not care, defer work as long as
4651 return (nl - b->ptr);
4655 b->ptr++; /* say we have read it as far as
4656 * flush() is concerned */
4657 b->buf++; /* Leave space in front of buffer */
4658 /* Note as we have moved buf up flush's
4660 will naturally make posn point at CR
4662 b->bufsiz--; /* Buffer is thus smaller */
4663 code = PerlIO_fill(f); /* Fetch some more */
4664 b->bufsiz++; /* Restore size for next time */
4665 b->buf--; /* Point at space */
4666 b->ptr = nl = b->buf; /* Which is what we hand
4668 *nl = NATIVE_0xd; /* Fill in the CR */
4670 goto test; /* fill() call worked */
4672 * CR at EOF - just fall through
4674 /* Should we clear EOF though ??? */
4679 return (((c->nl) ? (c->nl + 1) : b->end) - b->ptr);
4685 PerlIOCrlf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
4687 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4688 PerlIOCrlf * const c = PerlIOSelf(f, PerlIOCrlf);
4694 if (ptr == b->end && *c->nl == NATIVE_0xd) {
4695 /* Deferred CR at end of buffer case - we lied about count */
4708 * Test code - delete when it works ...
4710 IV flags = PerlIOBase(f)->flags;
4711 STDCHAR *chk = (c->nl) ? (c->nl+1) : b->end;
4712 if (ptr+cnt == c->nl && c->nl+1 == b->end && *c->nl == NATIVE_0xd) {
4713 /* Deferred CR at end of buffer case - we lied about count */
4719 Perl_croak(aTHX_ "ptr wrong %p != %p fl=%08" UVxf
4720 " nl=%p e=%p for %d", (void*)ptr, (void*)chk,
4721 flags, c->nl, b->end, cnt);
4728 * They have taken what we lied about
4730 *(c->nl) = NATIVE_0xd;
4736 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4740 PerlIOCrlf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4742 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF))
4743 return PerlIOBuf_write(aTHX_ f, vbuf, count);
4745 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
4746 const STDCHAR *buf = (const STDCHAR *) vbuf;
4747 const STDCHAR * const ebuf = buf + count;
4750 if (!(PerlIOBase(f)->flags & PERLIO_F_CANWRITE))
4752 while (buf < ebuf) {
4753 const STDCHAR * const eptr = b->buf + b->bufsiz;
4754 PerlIOBase(f)->flags |= PERLIO_F_WRBUF;
4755 while (buf < ebuf && b->ptr < eptr) {
4757 if ((b->ptr + 2) > eptr) {
4765 *(b->ptr)++ = NATIVE_0xd; /* CR */
4766 *(b->ptr)++ = NATIVE_0xa; /* LF */
4768 if (PerlIOBase(f)->flags & PERLIO_F_LINEBUF) {
4775 *(b->ptr)++ = *buf++;
4777 if (b->ptr >= eptr) {
4783 if (PerlIOBase(f)->flags & PERLIO_F_UNBUF)
4785 return (buf - (STDCHAR *) vbuf);
4790 PerlIOCrlf_flush(pTHX_ PerlIO *f)
4792 PerlIOCrlf * const c = PerlIOSelf(f, PerlIOCrlf);
4794 *(c->nl) = NATIVE_0xd;
4797 return PerlIOBuf_flush(aTHX_ f);
4801 PerlIOCrlf_binmode(pTHX_ PerlIO *f)
4803 if ((PerlIOBase(f)->flags & PERLIO_F_CRLF)) {
4804 /* In text mode - flush any pending stuff and flip it */
4805 PerlIOBase(f)->flags &= ~PERLIO_F_CRLF;
4806 #ifndef PERLIO_USING_CRLF
4807 /* CRLF is unusual case - if this is just the :crlf layer pop it */
4808 PerlIO_pop(aTHX_ f);
4811 return PerlIOBase_binmode(aTHX_ f);
4814 PERLIO_FUNCS_DECL(PerlIO_crlf) = {
4815 sizeof(PerlIO_funcs),
4818 PERLIO_K_BUFFERED | PERLIO_K_CANCRLF | PERLIO_K_RAW,
4820 PerlIOBuf_popped, /* popped */
4822 PerlIOCrlf_binmode, /* binmode */
4826 PerlIOBuf_read, /* generic read works with ptr/cnt lies */
4827 PerlIOCrlf_unread, /* Put CR,LF in buffer for each '\n' */
4828 PerlIOCrlf_write, /* Put CR,LF in buffer for each '\n' */
4836 PerlIOBase_clearerr,
4837 PerlIOBase_setlinebuf,
4842 PerlIOCrlf_set_ptrcnt,
4846 Perl_PerlIO_stdin(pTHX)
4849 PerlIO_stdstreams(aTHX);
4851 return (PerlIO*)&PL_perlio[1];
4855 Perl_PerlIO_stdout(pTHX)
4858 PerlIO_stdstreams(aTHX);
4860 return (PerlIO*)&PL_perlio[2];
4864 Perl_PerlIO_stderr(pTHX)
4867 PerlIO_stdstreams(aTHX);
4869 return (PerlIO*)&PL_perlio[3];
4872 /*--------------------------------------------------------------------------------------*/
4875 PerlIO_getname(PerlIO *f, char *buf)
4880 bool exported = FALSE;
4881 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
4883 stdio = PerlIO_exportFILE(f,0);
4887 name = fgetname(stdio, buf);
4888 if (exported) PerlIO_releaseFILE(f,stdio);
4893 PERL_UNUSED_ARG(buf);
4894 Perl_croak_nocontext("Don't know how to get file name");
4900 /*--------------------------------------------------------------------------------------*/
4902 * Functions which can be called on any kind of PerlIO implemented in
4906 #undef PerlIO_fdopen
4908 PerlIO_fdopen(int fd, const char *mode)
4911 return PerlIO_openn(aTHX_ NULL, mode, fd, 0, 0, NULL, 0, NULL);
4916 PerlIO_open(const char *path, const char *mode)
4919 SV *name = sv_2mortal(newSVpv(path, 0));
4920 return PerlIO_openn(aTHX_ NULL, mode, -1, 0, 0, NULL, 1, &name);
4923 #undef Perlio_reopen
4925 PerlIO_reopen(const char *path, const char *mode, PerlIO *f)
4928 SV *name = sv_2mortal(newSVpv(path,0));
4929 return PerlIO_openn(aTHX_ NULL, mode, -1, 0, 0, f, 1, &name);
4934 PerlIO_getc(PerlIO *f)
4938 if ( 1 == PerlIO_read(f, buf, 1) ) {
4939 return (unsigned char) buf[0];
4944 #undef PerlIO_ungetc
4946 PerlIO_ungetc(PerlIO *f, int ch)
4951 if (PerlIO_unread(f, &buf, 1) == 1)
4959 PerlIO_putc(PerlIO *f, int ch)
4963 return PerlIO_write(f, &buf, 1);
4968 PerlIO_puts(PerlIO *f, const char *s)
4971 return PerlIO_write(f, s, strlen(s));
4974 #undef PerlIO_rewind
4976 PerlIO_rewind(PerlIO *f)
4979 PerlIO_seek(f, (Off_t) 0, SEEK_SET);
4983 #undef PerlIO_vprintf
4985 PerlIO_vprintf(PerlIO *f, const char *fmt, va_list ap)
4994 Perl_va_copy(ap, apc);
4995 sv = vnewSVpvf(fmt, &apc);
4998 sv = vnewSVpvf(fmt, &ap);
5000 s = SvPV_const(sv, len);
5001 wrote = PerlIO_write(f, s, len);
5006 #undef PerlIO_printf
5008 PerlIO_printf(PerlIO *f, const char *fmt, ...)
5013 result = PerlIO_vprintf(f, fmt, ap);
5018 #undef PerlIO_stdoutf
5020 PerlIO_stdoutf(const char *fmt, ...)
5026 result = PerlIO_vprintf(PerlIO_stdout(), fmt, ap);
5031 #undef PerlIO_tmpfile
5033 PerlIO_tmpfile(void)
5035 return PerlIO_tmpfile_flags(0);
5038 #define MKOSTEMP_MODES ( O_RDWR | O_CREAT | O_EXCL )
5039 #define MKOSTEMP_MODE_MASK ( O_ACCMODE | O_CREAT | O_EXCL | O_TRUNC )
5042 PerlIO_tmpfile_flags(int imode)
5049 const int fd = win32_tmpfd_mode(imode);
5051 f = PerlIO_fdopen(fd, "w+b");
5052 #elif ! defined(OS2)
5054 char tempname[] = "/tmp/PerlIO_XXXXXX";
5055 const char * const tmpdir = TAINTING_get ? NULL : PerlEnv_getenv("TMPDIR");
5057 int old_umask = umask(0177);
5058 imode &= ~MKOSTEMP_MODE_MASK;
5059 if (tmpdir && *tmpdir) {
5060 /* if TMPDIR is set and not empty, we try that first */
5061 sv = newSVpv(tmpdir, 0);
5062 sv_catpv(sv, tempname + 4);
5063 fd = Perl_my_mkostemp_cloexec(SvPVX(sv), imode | O_VMS_DELETEONCLOSE);
5068 /* else we try /tmp */
5069 fd = Perl_my_mkostemp_cloexec(tempname, imode | O_VMS_DELETEONCLOSE);
5074 sv_catpv(sv, tempname + 4);
5075 fd = Perl_my_mkostemp_cloexec(SvPVX(sv), imode | O_VMS_DELETEONCLOSE);
5079 /* fdopen() with a numeric mode */
5082 (void)PerlIO_intmode2str(imode | MKOSTEMP_MODES, mode, &writing);
5083 f = PerlIO_fdopen(fd, mode);
5085 PerlIOBase(f)->flags |= PERLIO_F_TEMP;
5087 PerlLIO_unlink(sv ? SvPVX_const(sv) : tempname);
5091 #else /* !HAS_MKSTEMP, fallback to stdio tmpfile(). */
5092 FILE * const stdio = PerlSIO_tmpfile();
5095 f = PerlIO_fdopen(fileno(stdio), "w+");
5097 #endif /* else WIN32 */
5102 Perl_PerlIO_save_errno(pTHX_ PerlIO *f)
5104 PERL_UNUSED_CONTEXT;
5105 if (!PerlIOValid(f))
5107 PerlIOBase(f)->err = errno;
5109 PerlIOBase(f)->os_err = vaxc$errno;
5111 PerlIOBase(f)->os_err = Perl_rc;
5112 #elif defined(WIN32)
5113 PerlIOBase(f)->os_err = GetLastError();
5118 Perl_PerlIO_restore_errno(pTHX_ PerlIO *f)
5120 PERL_UNUSED_CONTEXT;
5121 if (!PerlIOValid(f))
5123 SETERRNO(PerlIOBase(f)->err, PerlIOBase(f)->os_err);
5125 Perl_rc = PerlIOBase(f)->os_err);
5126 #elif defined(WIN32)
5127 SetLastError(PerlIOBase(f)->os_err);
5135 /*======================================================================================*/
5137 * Now some functions in terms of above which may be needed even if we are
5138 * not in true PerlIO mode
5141 Perl_PerlIO_context_layers(pTHX_ const char *mode)
5143 const char *direction = NULL;
5146 * Need to supply default layer info from open.pm
5152 if (mode && mode[0] != 'r') {
5153 if (PL_curcop->cop_hints & HINT_LEXICAL_IO_OUT)
5154 direction = "open>";
5156 if (PL_curcop->cop_hints & HINT_LEXICAL_IO_IN)
5157 direction = "open<";
5162 layers = cop_hints_fetch_pvn(PL_curcop, direction, 5, 0, 0);
5165 return SvOK(layers) ? SvPV_nolen_const(layers) : NULL;
5170 #undef PerlIO_setpos
5172 PerlIO_setpos(PerlIO *f, SV *pos)
5178 const Off_t * const posn = (Off_t *) SvPV(pos, len);
5179 if(len == sizeof(Off_t))
5180 return PerlIO_seek(f, *posn, SEEK_SET);
5183 SETERRNO(EINVAL, SS_IVCHAN);
5187 #undef PerlIO_setpos
5189 PerlIO_setpos(PerlIO *f, SV *pos)
5195 Fpos_t * const fpos = (Fpos_t *) SvPV(pos, len);
5196 if(len == sizeof(Fpos_t))
5197 #if defined(USE_64_BIT_STDIO) && defined(USE_FSETPOS64)
5198 return fsetpos64(f, fpos);
5200 return fsetpos(f, fpos);
5204 SETERRNO(EINVAL, SS_IVCHAN);
5210 #undef PerlIO_getpos
5212 PerlIO_getpos(PerlIO *f, SV *pos)
5215 Off_t posn = PerlIO_tell(f);
5216 sv_setpvn(pos, (char *) &posn, sizeof(posn));
5217 return (posn == (Off_t) - 1) ? -1 : 0;
5220 #undef PerlIO_getpos
5222 PerlIO_getpos(PerlIO *f, SV *pos)
5227 #if defined(USE_64_BIT_STDIO) && defined(USE_FSETPOS64)
5228 code = fgetpos64(f, &fpos);
5230 code = fgetpos(f, &fpos);
5232 sv_setpvn(pos, (char *) &fpos, sizeof(fpos));
5237 /* print a failure format string message to stderr and fail exit the process
5238 using only libc without depending on any perl data structures being
5243 Perl_noperl_die(const char* pat, ...)
5246 PERL_ARGS_ASSERT_NOPERL_DIE;
5247 va_start(arglist, pat);
5248 vfprintf(stderr, pat, arglist);
5254 * ex: set ts=8 sts=4 sw=4 et: