2 * perlio.c Copyright (c) 1996-2005, Nick Ing-Simmons You may distribute
3 * under the terms of either the GNU General Public License or the
4 * Artistic License, as specified in the README file.
8 * Hour after hour for nearly three weary days he had jogged up and down,
9 * over passes, and through long dales, and across many streams.
12 /* This file contains the functions needed to implement PerlIO, which
13 * is Perl's private replacement for the C stdio library. This is used
14 * by default unless you compile with -Uuseperlio or run with
15 * PERLIO=:stdio (but don't do this unless you know what you're doing)
19 * If we have ActivePerl-like PERL_IMPLICIT_SYS then we need a dTHX to get
20 * at the dispatch tables, even when we do not need it for other reasons.
21 * Invent a dSYS macro to abstract this out
23 #ifdef PERL_IMPLICIT_SYS
36 #define PERLIO_NOT_STDIO 0
37 #if !defined(PERLIO_IS_STDIO) && !defined(USE_SFIO)
43 * This file provides those parts of PerlIO abstraction
44 * which are not #defined in perlio.h.
45 * Which these are depends on various Configure #ifdef's
49 #define PERL_IN_PERLIO_C
52 #ifdef PERL_IMPLICIT_CONTEXT
59 #define PERLIO_MAX_REFCOUNTABLE_FD 2048
62 /* Missing proto on LynxOS */
66 /* Call the callback or PerlIOBase, and return failure. */
67 #define Perl_PerlIO_or_Base(f, callback, base, failure, args) \
68 if (PerlIOValid(f)) { \
69 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;\
70 if (tab && tab->callback) \
71 return (*tab->callback) args; \
73 return PerlIOBase_ ## base args; \
76 SETERRNO(EBADF, SS_IVCHAN); \
79 /* Call the callback or fail, and return failure. */
80 #define Perl_PerlIO_or_fail(f, callback, failure, args) \
81 if (PerlIOValid(f)) { \
82 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;\
83 if (tab && tab->callback) \
84 return (*tab->callback) args; \
85 SETERRNO(EINVAL, LIB_INVARG); \
88 SETERRNO(EBADF, SS_IVCHAN); \
91 /* Call the callback or PerlIOBase, and be void. */
92 #define Perl_PerlIO_or_Base_void(f, callback, base, args) \
93 if (PerlIOValid(f)) { \
94 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;\
95 if (tab && tab->callback) \
96 (*tab->callback) args; \
98 PerlIOBase_ ## base args; \
101 SETERRNO(EBADF, SS_IVCHAN)
103 /* Call the callback or fail, and be void. */
104 #define Perl_PerlIO_or_fail_void(f, callback, args) \
105 if (PerlIOValid(f)) { \
106 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;\
107 if (tab && tab->callback) \
108 (*tab->callback) args; \
110 SETERRNO(EINVAL, LIB_INVARG); \
113 SETERRNO(EBADF, SS_IVCHAN)
116 #define O_ACCMODE 3 /* Assume traditional implementation */
120 PerlIO_intmode2str(int rawmode, char *mode, int *writing)
122 const int result = rawmode & O_ACCMODE;
127 ptype = IoTYPE_RDONLY;
130 ptype = IoTYPE_WRONLY;
138 *writing = (result != O_RDONLY);
140 if (result == O_RDONLY) {
144 else if (rawmode & O_APPEND) {
146 if (result != O_WRONLY)
151 if (result == O_WRONLY)
158 if (rawmode & O_BINARY)
164 #ifndef PERLIO_LAYERS
166 PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode, const char *names)
168 if (!names || !*names
169 || strEQ(names, ":crlf")
170 || strEQ(names, ":raw")
171 || strEQ(names, ":bytes")
175 Perl_croak(aTHX_ "Cannot apply \"%s\" in non-PerlIO perl", names);
183 PerlIO_destruct(pTHX)
188 PerlIO_binmode(pTHX_ PerlIO *fp, int iotype, int mode, const char *names)
191 PERL_UNUSED_ARG(iotype);
192 PERL_UNUSED_ARG(mode);
193 PERL_UNUSED_ARG(names);
196 return perlsio_binmode(fp, iotype, mode);
201 PerlIO_fdupopen(pTHX_ PerlIO *f, CLONE_PARAMS *param, int flags)
203 #if defined(PERL_MICRO) || defined(__SYMBIAN32__)
206 #ifdef PERL_IMPLICIT_SYS
207 return PerlSIO_fdupopen(f);
210 return win32_fdupopen(f);
213 const int fd = PerlLIO_dup(PerlIO_fileno(f));
216 int omode = fcntl(fd, F_GETFL);
218 omode = djgpp_get_stream_mode(f);
220 PerlIO_intmode2str(omode,mode,NULL);
221 /* the r+ is a hack */
222 return PerlIO_fdopen(fd, mode);
227 SETERRNO(EBADF, SS_IVCHAN);
237 * De-mux PerlIO_openn() into fdopen, freopen and fopen type entries
241 PerlIO_openn(pTHX_ const char *layers, const char *mode, int fd,
242 int imode, int perm, PerlIO *old, int narg, SV **args)
246 Perl_croak(aTHX_ "More than one argument to open");
248 if (*args == &PL_sv_undef)
249 return PerlIO_tmpfile();
251 const char *name = SvPV_nolen_const(*args);
252 if (*mode == IoTYPE_NUMERIC) {
253 fd = PerlLIO_open3(name, imode, perm);
255 return PerlIO_fdopen(fd, mode + 1);
258 return PerlIO_reopen(name, mode, old);
261 return PerlIO_open(name, mode);
266 return PerlIO_fdopen(fd, (char *) mode);
271 XS(XS_PerlIO__Layer__find)
275 Perl_croak(aTHX_ "Usage class->find(name[,load])");
277 const char *name = SvPV_nolen_const(ST(1));
278 ST(0) = (strEQ(name, "crlf")
279 || strEQ(name, "raw")) ? &PL_sv_yes : &PL_sv_undef;
286 Perl_boot_core_PerlIO(pTHX)
288 newXS("PerlIO::Layer::find", XS_PerlIO__Layer__find, __FILE__);
294 #ifdef PERLIO_IS_STDIO
300 * Does nothing (yet) except force this file to be included in perl
301 * binary. That allows this file to force inclusion of other functions
302 * that may be required by loadable extensions e.g. for
303 * FileHandle::tmpfile
307 #undef PerlIO_tmpfile
314 #else /* PERLIO_IS_STDIO */
322 * This section is just to make sure these functions get pulled in from
326 #undef PerlIO_tmpfile
337 * Force this file to be included in perl binary. Which allows this
338 * file to force inclusion of other functions that may be required by
339 * loadable extensions e.g. for FileHandle::tmpfile
343 * Hack sfio does its own 'autoflush' on stdout in common cases. Flush
344 * results in a lot of lseek()s to regular files and lot of small
347 sfset(sfstdout, SF_SHARE, 0);
350 /* This is not the reverse of PerlIO_exportFILE(), PerlIO_releaseFILE() is. */
352 PerlIO_importFILE(FILE *stdio, const char *mode)
354 const int fd = fileno(stdio);
355 if (!mode || !*mode) {
358 return PerlIO_fdopen(fd, mode);
362 PerlIO_findFILE(PerlIO *pio)
364 const int fd = PerlIO_fileno(pio);
365 FILE * const f = fdopen(fd, "r+");
367 if (!f && errno == EINVAL)
369 if (!f && errno == EINVAL)
376 /*======================================================================================*/
378 * Implement all the PerlIO interface ourselves.
384 * We _MUST_ have <unistd.h> if we are using lseek() and may have large
391 #include <sys/mman.h>
395 PerlIO_debug(const char *fmt, ...)
400 if (!PL_perlio_debug_fd && !PL_tainting && PL_uid == PL_euid && PL_gid == PL_egid) {
401 const char *s = PerlEnv_getenv("PERLIO_DEBUG");
403 PL_perlio_debug_fd = PerlLIO_open3(s, O_WRONLY | O_CREAT | O_APPEND, 0666);
405 PL_perlio_debug_fd = -1;
407 if (PL_perlio_debug_fd > 0) {
409 const char *s = CopFILE(PL_curcop);
412 /* Use fixed buffer as sv_catpvf etc. needs SVs */
416 len = sprintf(buffer, "%.40s:%" IVdf " ", s, (IV) CopLINE(PL_curcop));
417 vsprintf(buffer+len, fmt, ap);
418 PerlLIO_write(PL_perlio_debug_fd, buffer, strlen(buffer));
420 SV *sv = newSVpvn("", 0);
423 Perl_sv_catpvf(aTHX_ sv, "%s:%" IVdf " ", s,
424 (IV) CopLINE(PL_curcop));
425 Perl_sv_vcatpvf(aTHX_ sv, fmt, &ap);
427 s = SvPV_const(sv, len);
428 PerlLIO_write(PL_perlio_debug_fd, s, len);
435 /*--------------------------------------------------------------------------------------*/
438 * Inner level routines
442 * Table of pointers to the PerlIO structs (malloc'ed)
444 #define PERLIO_TABLE_SIZE 64
447 PerlIO_allocate(pTHX)
450 * Find a free slot in the table, allocating new table as necessary
455 while ((f = *last)) {
457 last = (PerlIO **) (f);
458 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
464 Newxz(f,PERLIO_TABLE_SIZE,PerlIO);
472 #undef PerlIO_fdupopen
474 PerlIO_fdupopen(pTHX_ PerlIO *f, CLONE_PARAMS *param, int flags)
476 if (PerlIOValid(f)) {
477 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;
478 PerlIO_debug("fdupopen f=%p param=%p\n",(void*)f,(void*)param);
480 return (*tab->Dup)(aTHX_ PerlIO_allocate(aTHX), f, param, flags);
482 return PerlIOBase_dup(aTHX_ PerlIO_allocate(aTHX), f, param, flags);
486 SETERRNO(EBADF, SS_IVCHAN);
492 PerlIO_cleantable(pTHX_ PerlIO **tablep)
494 PerlIO *table = *tablep;
497 PerlIO_cleantable(aTHX_(PerlIO **) & (table[0]));
498 for (i = PERLIO_TABLE_SIZE - 1; i > 0; i--) {
499 PerlIO *f = table + i;
511 PerlIO_list_alloc(pTHX)
514 Newxz(list, 1, PerlIO_list_t);
520 PerlIO_list_free(pTHX_ PerlIO_list_t *list)
523 if (--list->refcnt == 0) {
526 for (i = 0; i < list->cur; i++) {
527 if (list->array[i].arg)
528 SvREFCNT_dec(list->array[i].arg);
530 Safefree(list->array);
538 PerlIO_list_push(pTHX_ PerlIO_list_t *list, PerlIO_funcs *funcs, SV *arg)
541 if (list->cur >= list->len) {
544 Renew(list->array, list->len, PerlIO_pair_t);
546 Newx(list->array, list->len, PerlIO_pair_t);
548 p = &(list->array[list->cur++]);
550 if ((p->arg = arg)) {
551 (void)SvREFCNT_inc(arg);
556 PerlIO_clone_list(pTHX_ PerlIO_list_t *proto, CLONE_PARAMS *param)
558 PerlIO_list_t *list = (PerlIO_list_t *) NULL;
561 list = PerlIO_list_alloc(aTHX);
562 for (i=0; i < proto->cur; i++) {
564 if (proto->array[i].arg)
565 arg = PerlIO_sv_dup(aTHX_ proto->array[i].arg,param);
566 PerlIO_list_push(aTHX_ list, proto->array[i].funcs, arg);
573 PerlIO_clone(pTHX_ PerlInterpreter *proto, CLONE_PARAMS *param)
576 PerlIO **table = &proto->Iperlio;
579 PL_known_layers = PerlIO_clone_list(aTHX_ proto->Iknown_layers, param);
580 PL_def_layerlist = PerlIO_clone_list(aTHX_ proto->Idef_layerlist, param);
581 PerlIO_allocate(aTHX); /* root slot is never used */
582 PerlIO_debug("Clone %p from %p\n",aTHX,proto);
583 while ((f = *table)) {
585 table = (PerlIO **) (f++);
586 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
588 (void) fp_dup(f, 0, param);
594 PERL_UNUSED_ARG(proto);
595 PERL_UNUSED_ARG(param);
600 PerlIO_destruct(pTHX)
602 PerlIO **table = &PL_perlio;
605 PerlIO_debug("Destruct %p\n",aTHX);
607 while ((f = *table)) {
609 table = (PerlIO **) (f++);
610 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
614 if (l->tab->kind & PERLIO_K_DESTRUCT) {
615 PerlIO_debug("Destruct popping %s\n", l->tab->name);
629 PerlIO_pop(pTHX_ PerlIO *f)
633 PerlIO_debug("PerlIO_pop f=%p %s\n", (void*)f, l->tab->name);
634 if (l->tab->Popped) {
636 * If popped returns non-zero do not free its layer structure
637 * it has either done so itself, or it is shared and still in
640 if ((*l->tab->Popped) (aTHX_ f) != 0)
648 /* Return as an array the stack of layers on a filehandle. Note that
649 * the stack is returned top-first in the array, and there are three
650 * times as many array elements as there are layers in the stack: the
651 * first element of a layer triplet is the name, the second one is the
652 * arguments, and the third one is the flags. */
655 PerlIO_get_layers(pTHX_ PerlIO *f)
659 if (PerlIOValid(f)) {
660 PerlIOl *l = PerlIOBase(f);
663 SV *name = l->tab && l->tab->name ?
664 newSVpv(l->tab->name, 0) : &PL_sv_undef;
665 SV *arg = l->tab && l->tab->Getarg ?
666 (*l->tab->Getarg)(aTHX_ &l, 0, 0) : &PL_sv_undef;
669 av_push(av, newSViv((IV)l->flags));
677 /*--------------------------------------------------------------------------------------*/
679 * XS Interface for perl code
683 PerlIO_find_layer(pTHX_ const char *name, STRLEN len, int load)
687 if ((SSize_t) len <= 0)
689 for (i = 0; i < PL_known_layers->cur; i++) {
690 PerlIO_funcs * const f = PL_known_layers->array[i].funcs;
691 if (memEQ(f->name, name, len) && f->name[len] == 0) {
692 PerlIO_debug("%.*s => %p\n", (int) len, name, (void*)f);
696 if (load && PL_subname && PL_def_layerlist
697 && PL_def_layerlist->cur >= 2) {
698 if (PL_in_load_module) {
699 Perl_croak(aTHX_ "Recursive call to Perl_load_module in PerlIO_find_layer");
702 SV * const pkgsv = newSVpvn("PerlIO", 6);
703 SV * const layer = newSVpvn(name, len);
704 CV * const cv = get_cv("PerlIO::Layer::NoWarnings", FALSE);
706 SAVEINT(PL_in_load_module);
708 SAVEGENERICSV(PL_warnhook);
709 (void)SvREFCNT_inc(cv);
710 PL_warnhook = (SV *) cv;
714 * The two SVs are magically freed by load_module
716 Perl_load_module(aTHX_ 0, pkgsv, Nullsv, layer, Nullsv);
719 return PerlIO_find_layer(aTHX_ name, len, 0);
722 PerlIO_debug("Cannot find %.*s\n", (int) len, name);
726 #ifdef USE_ATTRIBUTES_FOR_PERLIO
729 perlio_mg_set(pTHX_ SV *sv, MAGIC *mg)
732 IO *io = GvIOn((GV *) SvRV(sv));
733 PerlIO *ifp = IoIFP(io);
734 PerlIO *ofp = IoOFP(io);
735 Perl_warn(aTHX_ "set %" SVf " %p %p %p", sv, io, ifp, ofp);
741 perlio_mg_get(pTHX_ SV *sv, MAGIC *mg)
744 IO *io = GvIOn((GV *) SvRV(sv));
745 PerlIO *ifp = IoIFP(io);
746 PerlIO *ofp = IoOFP(io);
747 Perl_warn(aTHX_ "get %" SVf " %p %p %p", sv, io, ifp, ofp);
753 perlio_mg_clear(pTHX_ SV *sv, MAGIC *mg)
755 Perl_warn(aTHX_ "clear %" SVf, sv);
760 perlio_mg_free(pTHX_ SV *sv, MAGIC *mg)
762 Perl_warn(aTHX_ "free %" SVf, sv);
766 MGVTBL perlio_vtab = {
774 XS(XS_io_MODIFY_SCALAR_ATTRIBUTES)
777 SV *sv = SvRV(ST(1));
782 sv_magic(sv, (SV *) av, PERL_MAGIC_ext, NULL, 0);
784 mg = mg_find(sv, PERL_MAGIC_ext);
785 mg->mg_virtual = &perlio_vtab;
787 Perl_warn(aTHX_ "attrib %" SVf, sv);
788 for (i = 2; i < items; i++) {
790 const char *name = SvPV_const(ST(i), len);
791 SV *layer = PerlIO_find_layer(aTHX_ name, len, 1);
793 av_push(av, SvREFCNT_inc(layer));
804 #endif /* USE_ATTIBUTES_FOR_PERLIO */
807 PerlIO_tab_sv(pTHX_ PerlIO_funcs *tab)
809 HV * const stash = gv_stashpv("PerlIO::Layer", TRUE);
810 SV * const sv = sv_bless(newRV_noinc(newSViv(PTR2IV(tab))), stash);
814 XS(XS_PerlIO__Layer__NoWarnings)
816 /* This is used as a %SIG{__WARN__} handler to supress warnings
817 during loading of layers.
821 PerlIO_debug("warning:%s\n",SvPV_nolen_const(ST(0)));
825 XS(XS_PerlIO__Layer__find)
829 Perl_croak(aTHX_ "Usage class->find(name[,load])");
832 const char * const name = SvPV_const(ST(1), len);
833 const bool load = (items > 2) ? SvTRUE(ST(2)) : 0;
834 PerlIO_funcs * const layer = PerlIO_find_layer(aTHX_ name, len, load);
836 (layer) ? sv_2mortal(PerlIO_tab_sv(aTHX_ layer)) :
843 PerlIO_define_layer(pTHX_ PerlIO_funcs *tab)
845 if (!PL_known_layers)
846 PL_known_layers = PerlIO_list_alloc(aTHX);
847 PerlIO_list_push(aTHX_ PL_known_layers, tab, Nullsv);
848 PerlIO_debug("define %s %p\n", tab->name, (void*)tab);
852 PerlIO_parse_layers(pTHX_ PerlIO_list_t *av, const char *names)
855 const char *s = names;
857 while (isSPACE(*s) || *s == ':')
862 const char *as = Nullch;
864 if (!isIDFIRST(*s)) {
866 * Message is consistent with how attribute lists are
867 * passed. Even though this means "foo : : bar" is
868 * seen as an invalid separator character.
870 const char q = ((*s == '\'') ? '"' : '\'');
871 if (ckWARN(WARN_LAYER))
872 Perl_warner(aTHX_ packWARN(WARN_LAYER),
873 "Invalid separator character %c%c%c in PerlIO layer specification %s",
875 SETERRNO(EINVAL, LIB_INVARG);
880 } while (isALNUM(*e));
896 * It's a nul terminated string, not allowed
897 * to \ the terminating null. Anything other
898 * character is passed over.
908 if (ckWARN(WARN_LAYER))
909 Perl_warner(aTHX_ packWARN(WARN_LAYER),
910 "Argument list not closed for PerlIO layer \"%.*s\"",
922 PerlIO_funcs * const layer =
923 PerlIO_find_layer(aTHX_ s, llen, 1);
925 PerlIO_list_push(aTHX_ av, layer,
931 if (ckWARN(WARN_LAYER))
932 Perl_warner(aTHX_ packWARN(WARN_LAYER), "Unknown PerlIO layer \"%.*s\"",
945 PerlIO_default_buffer(pTHX_ PerlIO_list_t *av)
947 PERLIO_FUNCS_DECL(*tab) = &PerlIO_perlio;
948 #ifdef PERLIO_USING_CRLF
951 if (PerlIO_stdio.Set_ptrcnt)
954 PerlIO_debug("Pushing %s\n", tab->name);
955 PerlIO_list_push(aTHX_ av, PerlIO_find_layer(aTHX_ tab->name, 0, 0),
960 PerlIO_arg_fetch(PerlIO_list_t *av, IV n)
962 return av->array[n].arg;
966 PerlIO_layer_fetch(pTHX_ PerlIO_list_t *av, IV n, PerlIO_funcs *def)
968 if (n >= 0 && n < av->cur) {
969 PerlIO_debug("Layer %" IVdf " is %s\n", n,
970 av->array[n].funcs->name);
971 return av->array[n].funcs;
974 Perl_croak(aTHX_ "panic: PerlIO layer array corrupt");
979 PerlIOPop_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
981 PERL_UNUSED_ARG(mode);
982 PERL_UNUSED_ARG(arg);
983 PERL_UNUSED_ARG(tab);
984 if (PerlIOValid(f)) {
992 PERLIO_FUNCS_DECL(PerlIO_remove) = {
993 sizeof(PerlIO_funcs),
996 PERLIO_K_DUMMY | PERLIO_K_UTF8,
1016 NULL, /* get_base */
1017 NULL, /* get_bufsiz */
1020 NULL, /* set_ptrcnt */
1024 PerlIO_default_layers(pTHX)
1026 if (!PL_def_layerlist) {
1027 const char *s = (PL_tainting) ? Nullch : PerlEnv_getenv("PERLIO");
1028 PERLIO_FUNCS_DECL(*osLayer) = &PerlIO_unix;
1029 PL_def_layerlist = PerlIO_list_alloc(aTHX);
1030 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_unix));
1032 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_win32));
1034 osLayer = &PerlIO_win32;
1037 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_raw));
1038 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_perlio));
1039 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_stdio));
1040 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_crlf));
1042 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_mmap));
1044 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_utf8));
1045 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_remove));
1046 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_byte));
1047 PerlIO_list_push(aTHX_ PL_def_layerlist,
1048 PerlIO_find_layer(aTHX_ osLayer->name, 0, 0),
1051 PerlIO_parse_layers(aTHX_ PL_def_layerlist, s);
1054 PerlIO_default_buffer(aTHX_ PL_def_layerlist);
1057 if (PL_def_layerlist->cur < 2) {
1058 PerlIO_default_buffer(aTHX_ PL_def_layerlist);
1060 return PL_def_layerlist;
1064 Perl_boot_core_PerlIO(pTHX)
1066 #ifdef USE_ATTRIBUTES_FOR_PERLIO
1067 newXS("io::MODIFY_SCALAR_ATTRIBUTES", XS_io_MODIFY_SCALAR_ATTRIBUTES,
1070 newXS("PerlIO::Layer::find", XS_PerlIO__Layer__find, __FILE__);
1071 newXS("PerlIO::Layer::NoWarnings", XS_PerlIO__Layer__NoWarnings, __FILE__);
1075 PerlIO_default_layer(pTHX_ I32 n)
1077 PerlIO_list_t * const av = PerlIO_default_layers(aTHX);
1080 return PerlIO_layer_fetch(aTHX_ av, n, PERLIO_FUNCS_CAST(&PerlIO_stdio));
1083 #define PerlIO_default_top() PerlIO_default_layer(aTHX_ -1)
1084 #define PerlIO_default_btm() PerlIO_default_layer(aTHX_ 0)
1087 PerlIO_stdstreams(pTHX)
1090 PerlIO_allocate(aTHX);
1091 PerlIO_fdopen(0, "Ir" PERLIO_STDTEXT);
1092 PerlIO_fdopen(1, "Iw" PERLIO_STDTEXT);
1093 PerlIO_fdopen(2, "Iw" PERLIO_STDTEXT);
1098 PerlIO_push(pTHX_ PerlIO *f, PERLIO_FUNCS_DECL(*tab), const char *mode, SV *arg)
1100 if (tab->fsize != sizeof(PerlIO_funcs)) {
1102 Perl_croak(aTHX_ "Layer does not match this perl");
1106 if (tab->size < sizeof(PerlIOl)) {
1109 /* Real layer with a data area */
1110 Newxc(l,tab->size,char,PerlIOl);
1112 Zero(l, tab->size, char);
1114 l->tab = (PerlIO_funcs*) tab;
1116 PerlIO_debug("PerlIO_push f=%p %s %s %p\n", (void*)f, tab->name,
1117 (mode) ? mode : "(Null)", (void*)arg);
1118 if (*l->tab->Pushed &&
1119 (*l->tab->Pushed) (aTHX_ f, mode, arg, (PerlIO_funcs*) tab) != 0) {
1120 PerlIO_pop(aTHX_ f);
1126 /* Pseudo-layer where push does its own stack adjust */
1127 PerlIO_debug("PerlIO_push f=%p %s %s %p\n", (void*)f, tab->name,
1128 (mode) ? mode : "(Null)", (void*)arg);
1130 (*tab->Pushed) (aTHX_ f, mode, arg, (PerlIO_funcs*) tab) != 0) {
1138 PerlIOBase_binmode(pTHX_ PerlIO *f)
1140 if (PerlIOValid(f)) {
1141 /* Is layer suitable for raw stream ? */
1142 if (PerlIOBase(f)->tab->kind & PERLIO_K_RAW) {
1143 /* Yes - turn off UTF-8-ness, to undo UTF-8 locale effects */
1144 PerlIOBase(f)->flags &= ~PERLIO_F_UTF8;
1147 /* Not suitable - pop it */
1148 PerlIO_pop(aTHX_ f);
1156 PerlIORaw_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1158 PERL_UNUSED_ARG(mode);
1159 PERL_UNUSED_ARG(arg);
1160 PERL_UNUSED_ARG(tab);
1162 if (PerlIOValid(f)) {
1167 * Strip all layers that are not suitable for a raw stream
1170 while (t && (l = *t)) {
1171 if (l->tab->Binmode) {
1172 /* Has a handler - normal case */
1173 if ((*l->tab->Binmode)(aTHX_ f) == 0) {
1175 /* Layer still there - move down a layer */
1184 /* No handler - pop it */
1185 PerlIO_pop(aTHX_ t);
1188 if (PerlIOValid(f)) {
1189 PerlIO_debug(":raw f=%p :%s\n", (void*)f, PerlIOBase(f)->tab->name);
1197 PerlIO_apply_layera(pTHX_ PerlIO *f, const char *mode,
1198 PerlIO_list_t *layers, IV n, IV max)
1202 PerlIO_funcs * const tab = PerlIO_layer_fetch(aTHX_ layers, n, NULL);
1204 if (!PerlIO_push(aTHX_ f, tab, mode, PerlIOArg)) {
1215 PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode, const char *names)
1219 PerlIO_list_t * const layers = PerlIO_list_alloc(aTHX);
1220 code = PerlIO_parse_layers(aTHX_ layers, names);
1222 code = PerlIO_apply_layera(aTHX_ f, mode, layers, 0, layers->cur);
1224 PerlIO_list_free(aTHX_ layers);
1230 /*--------------------------------------------------------------------------------------*/
1232 * Given the abstraction above the public API functions
1236 PerlIO_binmode(pTHX_ PerlIO *f, int iotype, int mode, const char *names)
1238 PerlIO_debug("PerlIO_binmode f=%p %s %c %x %s\n",
1239 (void*)f, PerlIOBase(f)->tab->name, iotype, mode,
1240 (names) ? names : "(Null)");
1242 /* Do not flush etc. if (e.g.) switching encodings.
1243 if a pushed layer knows it needs to flush lower layers
1244 (for example :unix which is never going to call them)
1245 it can do the flush when it is pushed.
1247 return PerlIO_apply_layers(aTHX_ f, NULL, names) == 0 ? TRUE : FALSE;
1250 /* Fake 5.6 legacy of using this call to turn ON O_TEXT */
1251 #ifdef PERLIO_USING_CRLF
1252 /* Legacy binmode only has meaning if O_TEXT has a value distinct from
1253 O_BINARY so we can look for it in mode.
1255 if (!(mode & O_BINARY)) {
1257 /* FIXME?: Looking down the layer stack seems wrong,
1258 but is a way of reaching past (say) an encoding layer
1259 to flip CRLF-ness of the layer(s) below
1262 /* Perhaps we should turn on bottom-most aware layer
1263 e.g. Ilya's idea that UNIX TTY could serve
1265 if (PerlIOBase(f)->tab->kind & PERLIO_K_CANCRLF) {
1266 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF)) {
1267 /* Not in text mode - flush any pending stuff and flip it */
1269 PerlIOBase(f)->flags |= PERLIO_F_CRLF;
1271 /* Only need to turn it on in one layer so we are done */
1276 /* Not finding a CRLF aware layer presumably means we are binary
1277 which is not what was requested - so we failed
1278 We _could_ push :crlf layer but so could caller
1283 /* Legacy binmode is now _defined_ as being equivalent to pushing :raw
1284 So code that used to be here is now in PerlIORaw_pushed().
1286 return PerlIO_push(aTHX_ f, PERLIO_FUNCS_CAST(&PerlIO_raw), Nullch, Nullsv) ? TRUE : FALSE;
1291 PerlIO__close(pTHX_ PerlIO *f)
1293 if (PerlIOValid(f)) {
1294 PerlIO_funcs * const tab = PerlIOBase(f)->tab;
1295 if (tab && tab->Close)
1296 return (*tab->Close)(aTHX_ f);
1298 return PerlIOBase_close(aTHX_ f);
1301 SETERRNO(EBADF, SS_IVCHAN);
1307 Perl_PerlIO_close(pTHX_ PerlIO *f)
1309 const int code = PerlIO__close(aTHX_ f);
1310 while (PerlIOValid(f)) {
1311 PerlIO_pop(aTHX_ f);
1317 Perl_PerlIO_fileno(pTHX_ PerlIO *f)
1319 Perl_PerlIO_or_Base(f, Fileno, fileno, -1, (aTHX_ f));
1323 PerlIO_context_layers(pTHX_ const char *mode)
1325 const char *type = NULL;
1327 * Need to supply default layer info from open.pm
1330 SV *layers = PL_curcop->cop_io;
1333 type = SvPV_const(layers, len);
1334 if (type && mode[0] != 'r') {
1336 * Skip to write part
1338 const char *s = strchr(type, 0);
1339 if (s && (STRLEN)(s - type) < len) {
1348 static PerlIO_funcs *
1349 PerlIO_layer_from_ref(pTHX_ SV *sv)
1352 * For any scalar type load the handler which is bundled with perl
1354 if (SvTYPE(sv) < SVt_PVAV)
1355 return PerlIO_find_layer(aTHX_ "scalar", 6, 1);
1358 * For other types allow if layer is known but don't try and load it
1360 switch (SvTYPE(sv)) {
1362 return PerlIO_find_layer(aTHX_ "Array", 5, 0);
1364 return PerlIO_find_layer(aTHX_ "Hash", 4, 0);
1366 return PerlIO_find_layer(aTHX_ "Code", 4, 0);
1368 return PerlIO_find_layer(aTHX_ "Glob", 4, 0);
1374 PerlIO_resolve_layers(pTHX_ const char *layers,
1375 const char *mode, int narg, SV **args)
1377 PerlIO_list_t *def = PerlIO_default_layers(aTHX);
1380 PerlIO_stdstreams(aTHX);
1384 * If it is a reference but not an object see if we have a handler
1387 if (SvROK(arg) && !sv_isobject(arg)) {
1388 PerlIO_funcs * const handler = PerlIO_layer_from_ref(aTHX_ SvRV(arg));
1390 def = PerlIO_list_alloc(aTHX);
1391 PerlIO_list_push(aTHX_ def, handler, &PL_sv_undef);
1395 * Don't fail if handler cannot be found :via(...) etc. may do
1396 * something sensible else we will just stringfy and open
1402 layers = PerlIO_context_layers(aTHX_ mode);
1403 if (layers && *layers) {
1407 av = PerlIO_list_alloc(aTHX);
1408 for (i = 0; i < def->cur; i++) {
1409 PerlIO_list_push(aTHX_ av, def->array[i].funcs,
1416 if (PerlIO_parse_layers(aTHX_ av, layers) == 0) {
1420 PerlIO_list_free(aTHX_ av);
1421 return (PerlIO_list_t *) NULL;
1432 PerlIO_openn(pTHX_ const char *layers, const char *mode, int fd,
1433 int imode, int perm, PerlIO *f, int narg, SV **args)
1435 if (!f && narg == 1 && *args == &PL_sv_undef) {
1436 if ((f = PerlIO_tmpfile())) {
1438 layers = PerlIO_context_layers(aTHX_ mode);
1439 if (layers && *layers)
1440 PerlIO_apply_layers(aTHX_ f, mode, layers);
1444 PerlIO_list_t *layera;
1446 PerlIO_funcs *tab = NULL;
1447 if (PerlIOValid(f)) {
1449 * This is "reopen" - it is not tested as perl does not use it
1453 layera = PerlIO_list_alloc(aTHX);
1455 SV * const arg = (l->tab->Getarg)
1456 ? (*l->tab->Getarg) (aTHX_ &l, NULL, 0)
1458 PerlIO_list_push(aTHX_ layera, l->tab, arg);
1459 l = *PerlIONext(&l);
1463 layera = PerlIO_resolve_layers(aTHX_ layers, mode, narg, args);
1469 * Start at "top" of layer stack
1471 n = layera->cur - 1;
1473 PerlIO_funcs * const t = PerlIO_layer_fetch(aTHX_ layera, n, NULL);
1482 * Found that layer 'n' can do opens - call it
1484 if (narg > 1 && !(tab->kind & PERLIO_K_MULTIARG)) {
1485 Perl_croak(aTHX_ "More than one argument to open(,':%s')",tab->name);
1487 PerlIO_debug("openn(%s,'%s','%s',%d,%x,%o,%p,%d,%p)\n",
1488 tab->name, layers, mode, fd, imode, perm,
1489 (void*)f, narg, (void*)args);
1491 f = (*tab->Open) (aTHX_ tab, layera, n, mode, fd, imode, perm,
1494 SETERRNO(EINVAL, LIB_INVARG);
1498 if (n + 1 < layera->cur) {
1500 * More layers above the one that we used to open -
1503 if (PerlIO_apply_layera(aTHX_ f, mode, layera, n + 1, layera->cur) != 0) {
1504 /* If pushing layers fails close the file */
1511 PerlIO_list_free(aTHX_ layera);
1518 Perl_PerlIO_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
1520 Perl_PerlIO_or_Base(f, Read, read, -1, (aTHX_ f, vbuf, count));
1524 Perl_PerlIO_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
1526 Perl_PerlIO_or_Base(f, Unread, unread, -1, (aTHX_ f, vbuf, count));
1530 Perl_PerlIO_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
1532 Perl_PerlIO_or_fail(f, Write, -1, (aTHX_ f, vbuf, count));
1536 Perl_PerlIO_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
1538 Perl_PerlIO_or_fail(f, Seek, -1, (aTHX_ f, offset, whence));
1542 Perl_PerlIO_tell(pTHX_ PerlIO *f)
1544 Perl_PerlIO_or_fail(f, Tell, -1, (aTHX_ f));
1548 Perl_PerlIO_flush(pTHX_ PerlIO *f)
1552 const PerlIO_funcs *tab = PerlIOBase(f)->tab;
1554 if (tab && tab->Flush)
1555 return (*tab->Flush) (aTHX_ f);
1557 return 0; /* If no Flush defined, silently succeed. */
1560 PerlIO_debug("Cannot flush f=%p\n", (void*)f);
1561 SETERRNO(EBADF, SS_IVCHAN);
1567 * Is it good API design to do flush-all on NULL, a potentially
1568 * errorneous input? Maybe some magical value (PerlIO*
1569 * PERLIO_FLUSH_ALL = (PerlIO*)-1;)? Yes, stdio does similar
1570 * things on fflush(NULL), but should we be bound by their design
1573 PerlIO **table = &PL_perlio;
1575 while ((f = *table)) {
1577 table = (PerlIO **) (f++);
1578 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
1579 if (*f && PerlIO_flush(f) != 0)
1589 PerlIOBase_flush_linebuf(pTHX)
1591 PerlIO **table = &PL_perlio;
1593 while ((f = *table)) {
1595 table = (PerlIO **) (f++);
1596 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
1599 flags & (PERLIO_F_LINEBUF | PERLIO_F_CANWRITE))
1600 == (PERLIO_F_LINEBUF | PERLIO_F_CANWRITE))
1608 Perl_PerlIO_fill(pTHX_ PerlIO *f)
1610 Perl_PerlIO_or_fail(f, Fill, -1, (aTHX_ f));
1614 PerlIO_isutf8(PerlIO *f)
1617 return (PerlIOBase(f)->flags & PERLIO_F_UTF8) != 0;
1619 SETERRNO(EBADF, SS_IVCHAN);
1625 Perl_PerlIO_eof(pTHX_ PerlIO *f)
1627 Perl_PerlIO_or_Base(f, Eof, eof, -1, (aTHX_ f));
1631 Perl_PerlIO_error(pTHX_ PerlIO *f)
1633 Perl_PerlIO_or_Base(f, Error, error, -1, (aTHX_ f));
1637 Perl_PerlIO_clearerr(pTHX_ PerlIO *f)
1639 Perl_PerlIO_or_Base_void(f, Clearerr, clearerr, (aTHX_ f));
1643 Perl_PerlIO_setlinebuf(pTHX_ PerlIO *f)
1645 Perl_PerlIO_or_Base_void(f, Setlinebuf, setlinebuf, (aTHX_ f));
1649 PerlIO_has_base(PerlIO *f)
1651 if (PerlIOValid(f)) {
1652 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;
1655 return (tab->Get_base != NULL);
1656 SETERRNO(EINVAL, LIB_INVARG);
1659 SETERRNO(EBADF, SS_IVCHAN);
1665 PerlIO_fast_gets(PerlIO *f)
1667 if (PerlIOValid(f) && (PerlIOBase(f)->flags & PERLIO_F_FASTGETS)) {
1668 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;
1671 return (tab->Set_ptrcnt != NULL);
1672 SETERRNO(EINVAL, LIB_INVARG);
1675 SETERRNO(EBADF, SS_IVCHAN);
1681 PerlIO_has_cntptr(PerlIO *f)
1683 if (PerlIOValid(f)) {
1684 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;
1687 return (tab->Get_ptr != NULL && tab->Get_cnt != NULL);
1688 SETERRNO(EINVAL, LIB_INVARG);
1691 SETERRNO(EBADF, SS_IVCHAN);
1697 PerlIO_canset_cnt(PerlIO *f)
1699 if (PerlIOValid(f)) {
1700 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;
1703 return (tab->Set_ptrcnt != NULL);
1704 SETERRNO(EINVAL, LIB_INVARG);
1707 SETERRNO(EBADF, SS_IVCHAN);
1713 Perl_PerlIO_get_base(pTHX_ PerlIO *f)
1715 Perl_PerlIO_or_fail(f, Get_base, NULL, (aTHX_ f));
1719 Perl_PerlIO_get_bufsiz(pTHX_ PerlIO *f)
1721 Perl_PerlIO_or_fail(f, Get_bufsiz, -1, (aTHX_ f));
1725 Perl_PerlIO_get_ptr(pTHX_ PerlIO *f)
1727 Perl_PerlIO_or_fail(f, Get_ptr, NULL, (aTHX_ f));
1731 Perl_PerlIO_get_cnt(pTHX_ PerlIO *f)
1733 Perl_PerlIO_or_fail(f, Get_cnt, -1, (aTHX_ f));
1737 Perl_PerlIO_set_cnt(pTHX_ PerlIO *f, int cnt)
1739 Perl_PerlIO_or_fail_void(f, Set_ptrcnt, (aTHX_ f, NULL, cnt));
1743 Perl_PerlIO_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, int cnt)
1745 Perl_PerlIO_or_fail_void(f, Set_ptrcnt, (aTHX_ f, ptr, cnt));
1749 /*--------------------------------------------------------------------------------------*/
1751 * utf8 and raw dummy layers
1755 PerlIOUtf8_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1757 PERL_UNUSED_ARG(mode);
1758 PERL_UNUSED_ARG(arg);
1759 if (PerlIOValid(f)) {
1760 if (tab->kind & PERLIO_K_UTF8)
1761 PerlIOBase(f)->flags |= PERLIO_F_UTF8;
1763 PerlIOBase(f)->flags &= ~PERLIO_F_UTF8;
1769 PERLIO_FUNCS_DECL(PerlIO_utf8) = {
1770 sizeof(PerlIO_funcs),
1773 PERLIO_K_DUMMY | PERLIO_K_UTF8,
1793 NULL, /* get_base */
1794 NULL, /* get_bufsiz */
1797 NULL, /* set_ptrcnt */
1800 PERLIO_FUNCS_DECL(PerlIO_byte) = {
1801 sizeof(PerlIO_funcs),
1824 NULL, /* get_base */
1825 NULL, /* get_bufsiz */
1828 NULL, /* set_ptrcnt */
1832 PerlIORaw_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
1833 IV n, const char *mode, int fd, int imode, int perm,
1834 PerlIO *old, int narg, SV **args)
1836 PerlIO_funcs * const tab = PerlIO_default_btm();
1837 PERL_UNUSED_ARG(self);
1838 if (tab && tab->Open)
1839 return (*tab->Open) (aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
1841 SETERRNO(EINVAL, LIB_INVARG);
1845 PERLIO_FUNCS_DECL(PerlIO_raw) = {
1846 sizeof(PerlIO_funcs),
1869 NULL, /* get_base */
1870 NULL, /* get_bufsiz */
1873 NULL, /* set_ptrcnt */
1875 /*--------------------------------------------------------------------------------------*/
1876 /*--------------------------------------------------------------------------------------*/
1878 * "Methods" of the "base class"
1882 PerlIOBase_fileno(pTHX_ PerlIO *f)
1884 return PerlIOValid(f) ? PerlIO_fileno(PerlIONext(f)) : -1;
1888 PerlIO_modestr(PerlIO * f, char *buf)
1891 if (PerlIOValid(f)) {
1892 const IV flags = PerlIOBase(f)->flags;
1893 if (flags & PERLIO_F_APPEND) {
1895 if (flags & PERLIO_F_CANREAD) {
1899 else if (flags & PERLIO_F_CANREAD) {
1901 if (flags & PERLIO_F_CANWRITE)
1904 else if (flags & PERLIO_F_CANWRITE) {
1906 if (flags & PERLIO_F_CANREAD) {
1910 #ifdef PERLIO_USING_CRLF
1911 if (!(flags & PERLIO_F_CRLF))
1921 PerlIOBase_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1923 PerlIOl * const l = PerlIOBase(f);
1924 PERL_UNUSED_ARG(arg);
1926 l->flags &= ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE |
1927 PERLIO_F_TRUNCATE | PERLIO_F_APPEND);
1928 if (tab->Set_ptrcnt != NULL)
1929 l->flags |= PERLIO_F_FASTGETS;
1931 if (*mode == IoTYPE_NUMERIC || *mode == IoTYPE_IMPLICIT)
1935 l->flags |= PERLIO_F_CANREAD;
1938 l->flags |= PERLIO_F_APPEND | PERLIO_F_CANWRITE;
1941 l->flags |= PERLIO_F_TRUNCATE | PERLIO_F_CANWRITE;
1944 SETERRNO(EINVAL, LIB_INVARG);
1950 l->flags |= PERLIO_F_CANREAD | PERLIO_F_CANWRITE;
1953 l->flags &= ~PERLIO_F_CRLF;
1956 l->flags |= PERLIO_F_CRLF;
1959 SETERRNO(EINVAL, LIB_INVARG);
1966 l->flags |= l->next->flags &
1967 (PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_TRUNCATE |
1972 PerlIO_debug("PerlIOBase_pushed f=%p %s %s fl=%08" UVxf " (%s)\n",
1973 f, PerlIOBase(f)->tab->name, (omode) ? omode : "(Null)",
1974 l->flags, PerlIO_modestr(f, temp));
1980 PerlIOBase_popped(pTHX_ PerlIO *f)
1987 PerlIOBase_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
1990 * Save the position as current head considers it
1992 const Off_t old = PerlIO_tell(f);
1993 PerlIO_push(aTHX_ f, PERLIO_FUNCS_CAST(&PerlIO_pending), "r", Nullsv);
1994 PerlIOSelf(f, PerlIOBuf)->posn = old;
1995 return PerlIOBuf_unread(aTHX_ f, vbuf, count);
1999 PerlIOBase_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
2001 STDCHAR *buf = (STDCHAR *) vbuf;
2003 if (!(PerlIOBase(f)->flags & PERLIO_F_CANREAD)) {
2004 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2005 SETERRNO(EBADF, SS_IVCHAN);
2011 SSize_t avail = PerlIO_get_cnt(f);
2014 take = ((SSize_t)count < avail) ? count : avail;
2016 STDCHAR *ptr = PerlIO_get_ptr(f);
2017 Copy(ptr, buf, take, STDCHAR);
2018 PerlIO_set_ptrcnt(f, ptr + take, (avail -= take));
2021 if (avail == 0) /* set_ptrcnt could have reset avail */
2024 if (count > 0 && avail <= 0) {
2025 if (PerlIO_fill(f) != 0)
2030 return (buf - (STDCHAR *) vbuf);
2036 PerlIOBase_noop_ok(pTHX_ PerlIO *f)
2043 PerlIOBase_noop_fail(pTHX_ PerlIO *f)
2050 PerlIOBase_close(pTHX_ PerlIO *f)
2053 if (PerlIOValid(f)) {
2054 PerlIO *n = PerlIONext(f);
2055 code = PerlIO_flush(f);
2056 PerlIOBase(f)->flags &=
2057 ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_OPEN);
2058 while (PerlIOValid(n)) {
2059 const PerlIO_funcs * const tab = PerlIOBase(n)->tab;
2060 if (tab && tab->Close) {
2061 if ((*tab->Close)(aTHX_ n) != 0)
2066 PerlIOBase(n)->flags &=
2067 ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_OPEN);
2073 SETERRNO(EBADF, SS_IVCHAN);
2079 PerlIOBase_eof(pTHX_ PerlIO *f)
2081 if (PerlIOValid(f)) {
2082 return (PerlIOBase(f)->flags & PERLIO_F_EOF) != 0;
2088 PerlIOBase_error(pTHX_ PerlIO *f)
2090 if (PerlIOValid(f)) {
2091 return (PerlIOBase(f)->flags & PERLIO_F_ERROR) != 0;
2097 PerlIOBase_clearerr(pTHX_ PerlIO *f)
2099 if (PerlIOValid(f)) {
2100 PerlIO *n = PerlIONext(f);
2101 PerlIOBase(f)->flags &= ~(PERLIO_F_ERROR | PERLIO_F_EOF);
2108 PerlIOBase_setlinebuf(pTHX_ PerlIO *f)
2110 if (PerlIOValid(f)) {
2111 PerlIOBase(f)->flags |= PERLIO_F_LINEBUF;
2116 PerlIO_sv_dup(pTHX_ SV *arg, CLONE_PARAMS *param)
2122 return sv_dup(arg, param);
2125 return newSVsv(arg);
2128 PERL_UNUSED_ARG(param);
2129 return newSVsv(arg);
2134 PerlIOBase_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2136 PerlIO * const nexto = PerlIONext(o);
2137 if (PerlIOValid(nexto)) {
2138 const PerlIO_funcs * const tab = PerlIOBase(nexto)->tab;
2139 if (tab && tab->Dup)
2140 f = (*tab->Dup)(aTHX_ f, nexto, param, flags);
2142 f = PerlIOBase_dup(aTHX_ f, nexto, param, flags);
2145 PerlIO_funcs *self = PerlIOBase(o)->tab;
2148 PerlIO_debug("PerlIOBase_dup %s f=%p o=%p param=%p\n",
2149 self->name, (void*)f, (void*)o, (void*)param);
2151 arg = (*self->Getarg)(aTHX_ o, param, flags);
2155 f = PerlIO_push(aTHX_ f, self, PerlIO_modestr(o,buf), arg);
2164 perl_mutex PerlIO_mutex;
2167 /* PL_perlio_fd_refcnt[] is in intrpvar.h */
2172 /* Place holder for stdstreams call ??? */
2174 MUTEX_INIT(&PerlIO_mutex);
2179 PerlIOUnix_refcnt_inc(int fd)
2182 if (fd >= 0 && fd < PERLIO_MAX_REFCOUNTABLE_FD) {
2184 MUTEX_LOCK(&PerlIO_mutex);
2186 PL_perlio_fd_refcnt[fd]++;
2187 PerlIO_debug("fd %d refcnt=%d\n",fd,PL_perlio_fd_refcnt[fd]);
2189 MUTEX_UNLOCK(&PerlIO_mutex);
2195 PerlIOUnix_refcnt_dec(int fd)
2199 if (fd >= 0 && fd < PERLIO_MAX_REFCOUNTABLE_FD) {
2201 MUTEX_LOCK(&PerlIO_mutex);
2203 cnt = --PL_perlio_fd_refcnt[fd];
2204 PerlIO_debug("fd %d refcnt=%d\n",fd,cnt);
2206 MUTEX_UNLOCK(&PerlIO_mutex);
2213 PerlIO_cleanup(pTHX)
2217 PerlIO_debug("Cleanup layers for %p\n",aTHX);
2219 PerlIO_debug("Cleanup layers\n");
2221 /* Raise STDIN..STDERR refcount so we don't close them */
2222 for (i=0; i < 3; i++)
2223 PerlIOUnix_refcnt_inc(i);
2224 PerlIO_cleantable(aTHX_ &PL_perlio);
2225 /* Restore STDIN..STDERR refcount */
2226 for (i=0; i < 3; i++)
2227 PerlIOUnix_refcnt_dec(i);
2229 if (PL_known_layers) {
2230 PerlIO_list_free(aTHX_ PL_known_layers);
2231 PL_known_layers = NULL;
2233 if (PL_def_layerlist) {
2234 PerlIO_list_free(aTHX_ PL_def_layerlist);
2235 PL_def_layerlist = NULL;
2241 /*--------------------------------------------------------------------------------------*/
2243 * Bottom-most level for UNIX-like case
2247 struct _PerlIO base; /* The generic part */
2248 int fd; /* UNIX like file descriptor */
2249 int oflags; /* open/fcntl flags */
2253 PerlIOUnix_oflags(const char *mode)
2256 if (*mode == IoTYPE_IMPLICIT || *mode == IoTYPE_NUMERIC)
2261 if (*++mode == '+') {
2268 oflags = O_CREAT | O_TRUNC;
2269 if (*++mode == '+') {
2278 oflags = O_CREAT | O_APPEND;
2279 if (*++mode == '+') {
2292 else if (*mode == 't') {
2294 oflags &= ~O_BINARY;
2298 * Always open in binary mode
2301 if (*mode || oflags == -1) {
2302 SETERRNO(EINVAL, LIB_INVARG);
2309 PerlIOUnix_fileno(pTHX_ PerlIO *f)
2311 return PerlIOSelf(f, PerlIOUnix)->fd;
2315 PerlIOUnix_setfd(pTHX_ PerlIO *f, int fd, int imode)
2317 PerlIOUnix * const s = PerlIOSelf(f, PerlIOUnix);
2320 if (PerlLIO_fstat(fd, &st) == 0) {
2321 if (!S_ISREG(st.st_mode)) {
2322 PerlIO_debug("%d is not regular file\n",fd);
2323 PerlIOBase(f)->flags |= PERLIO_F_NOTREG;
2326 PerlIO_debug("%d _is_ a regular file\n",fd);
2332 PerlIOUnix_refcnt_inc(fd);
2336 PerlIOUnix_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2338 IV code = PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
2339 if (*PerlIONext(f)) {
2340 /* We never call down so do any pending stuff now */
2341 PerlIO_flush(PerlIONext(f));
2343 * XXX could (or should) we retrieve the oflags from the open file
2344 * handle rather than believing the "mode" we are passed in? XXX
2345 * Should the value on NULL mode be 0 or -1?
2347 PerlIOUnix_setfd(aTHX_ f, PerlIO_fileno(PerlIONext(f)),
2348 mode ? PerlIOUnix_oflags(mode) : -1);
2350 PerlIOBase(f)->flags |= PERLIO_F_OPEN;
2356 PerlIOUnix_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
2358 const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2360 if (PerlIOBase(f)->flags & PERLIO_F_NOTREG) {
2362 SETERRNO(ESPIPE, LIB_INVARG);
2364 SETERRNO(EINVAL, LIB_INVARG);
2368 new_loc = PerlLIO_lseek(fd, offset, whence);
2369 if (new_loc == (Off_t) - 1)
2373 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
2378 PerlIOUnix_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
2379 IV n, const char *mode, int fd, int imode,
2380 int perm, PerlIO *f, int narg, SV **args)
2382 if (PerlIOValid(f)) {
2383 if (PerlIOBase(f)->flags & PERLIO_F_OPEN)
2384 (*PerlIOBase(f)->tab->Close)(aTHX_ f);
2387 if (*mode == IoTYPE_NUMERIC)
2390 imode = PerlIOUnix_oflags(mode);
2394 const char *path = SvPV_nolen_const(*args);
2395 fd = PerlLIO_open3(path, imode, perm);
2399 if (*mode == IoTYPE_IMPLICIT)
2402 f = PerlIO_allocate(aTHX);
2404 if (!PerlIOValid(f)) {
2405 if (!(f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg))) {
2409 PerlIOUnix_setfd(aTHX_ f, fd, imode);
2410 PerlIOBase(f)->flags |= PERLIO_F_OPEN;
2411 if (*mode == IoTYPE_APPEND)
2412 PerlIOUnix_seek(aTHX_ f, 0, SEEK_END);
2418 * FIXME: pop layers ???
2426 PerlIOUnix_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2428 PerlIOUnix *os = PerlIOSelf(o, PerlIOUnix);
2430 if (flags & PERLIO_DUP_FD) {
2431 fd = PerlLIO_dup(fd);
2433 if (fd >= 0 && fd < PERLIO_MAX_REFCOUNTABLE_FD) {
2434 f = PerlIOBase_dup(aTHX_ f, o, param, flags);
2436 /* If all went well overwrite fd in dup'ed lay with the dup()'ed fd */
2437 PerlIOUnix_setfd(aTHX_ f, fd, os->oflags);
2446 PerlIOUnix_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
2448 const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2449 #ifdef PERLIO_STD_SPECIAL
2451 return PERLIO_STD_IN(fd, vbuf, count);
2453 if (!(PerlIOBase(f)->flags & PERLIO_F_CANREAD) ||
2454 PerlIOBase(f)->flags & (PERLIO_F_EOF|PERLIO_F_ERROR)) {
2458 const SSize_t len = PerlLIO_read(fd, vbuf, count);
2459 if (len >= 0 || errno != EINTR) {
2461 if (errno != EAGAIN) {
2462 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2465 else if (len == 0 && count != 0) {
2466 PerlIOBase(f)->flags |= PERLIO_F_EOF;
2477 PerlIOUnix_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
2479 const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2480 #ifdef PERLIO_STD_SPECIAL
2481 if (fd == 1 || fd == 2)
2482 return PERLIO_STD_OUT(fd, vbuf, count);
2485 const SSize_t len = PerlLIO_write(fd, vbuf, count);
2486 if (len >= 0 || errno != EINTR) {
2488 if (errno != EAGAIN) {
2489 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2500 PerlIOUnix_tell(pTHX_ PerlIO *f)
2502 return PerlLIO_lseek(PerlIOSelf(f, PerlIOUnix)->fd, 0, SEEK_CUR);
2507 PerlIOUnix_close(pTHX_ PerlIO *f)
2509 const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2511 if (PerlIOBase(f)->flags & PERLIO_F_OPEN) {
2512 if (PerlIOUnix_refcnt_dec(fd) > 0) {
2513 PerlIOBase(f)->flags &= ~PERLIO_F_OPEN;
2518 SETERRNO(EBADF,SS_IVCHAN);
2521 while (PerlLIO_close(fd) != 0) {
2522 if (errno != EINTR) {
2529 PerlIOBase(f)->flags &= ~PERLIO_F_OPEN;
2534 PERLIO_FUNCS_DECL(PerlIO_unix) = {
2535 sizeof(PerlIO_funcs),
2542 PerlIOBase_binmode, /* binmode */
2552 PerlIOBase_noop_ok, /* flush */
2553 PerlIOBase_noop_fail, /* fill */
2556 PerlIOBase_clearerr,
2557 PerlIOBase_setlinebuf,
2558 NULL, /* get_base */
2559 NULL, /* get_bufsiz */
2562 NULL, /* set_ptrcnt */
2565 /*--------------------------------------------------------------------------------------*/
2570 #if defined(VMS) && !defined(STDIO_BUFFER_WRITABLE)
2571 /* perl5.8 - This ensures the last minute VMS ungetc fix is not
2572 broken by the last second glibc 2.3 fix
2574 #define STDIO_BUFFER_WRITABLE
2579 struct _PerlIO base;
2580 FILE *stdio; /* The stream */
2584 PerlIOStdio_fileno(pTHX_ PerlIO *f)
2587 if (PerlIOValid(f) && (s = PerlIOSelf(f, PerlIOStdio)->stdio)) {
2588 return PerlSIO_fileno(s);
2595 PerlIOStdio_mode(const char *mode, char *tmode)
2597 char * const ret = tmode;
2603 #if defined(PERLIO_USING_CRLF) || defined(__CYGWIN__)
2611 PerlIOStdio_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2614 if (PerlIOValid(f) && PerlIOValid(n = PerlIONext(f))) {
2615 PerlIO_funcs * const toptab = PerlIOBase(n)->tab;
2616 if (toptab == tab) {
2617 /* Top is already stdio - pop self (duplicate) and use original */
2618 PerlIO_pop(aTHX_ f);
2621 const int fd = PerlIO_fileno(n);
2624 if (fd >= 0 && (stdio = PerlSIO_fdopen(fd,
2625 mode = PerlIOStdio_mode(mode, tmode)))) {
2626 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2627 /* We never call down so do any pending stuff now */
2628 PerlIO_flush(PerlIONext(f));
2635 return PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
2640 PerlIO_importFILE(FILE *stdio, const char *mode)
2646 if (!mode || !*mode) {
2647 /* We need to probe to see how we can open the stream
2648 so start with read/write and then try write and read
2649 we dup() so that we can fclose without loosing the fd.
2651 Note that the errno value set by a failing fdopen
2652 varies between stdio implementations.
2654 const int fd = PerlLIO_dup(fileno(stdio));
2655 FILE *f2 = PerlSIO_fdopen(fd, (mode = "r+"));
2657 f2 = PerlSIO_fdopen(fd, (mode = "w"));
2660 f2 = PerlSIO_fdopen(fd, (mode = "r"));
2663 /* Don't seem to be able to open */
2669 if ((f = PerlIO_push(aTHX_(f = PerlIO_allocate(aTHX)), PERLIO_FUNCS_CAST(&PerlIO_stdio), mode, Nullsv))) {
2670 s = PerlIOSelf(f, PerlIOStdio);
2678 PerlIOStdio_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
2679 IV n, const char *mode, int fd, int imode,
2680 int perm, PerlIO *f, int narg, SV **args)
2683 if (PerlIOValid(f)) {
2684 const char *path = SvPV_nolen_const(*args);
2685 PerlIOStdio *s = PerlIOSelf(f, PerlIOStdio);
2687 PerlIOUnix_refcnt_dec(fileno(s->stdio));
2688 stdio = PerlSIO_freopen(path, (mode = PerlIOStdio_mode(mode, tmode)),
2693 PerlIOUnix_refcnt_inc(fileno(s->stdio));
2698 const char *path = SvPV_nolen_const(*args);
2699 if (*mode == IoTYPE_NUMERIC) {
2701 fd = PerlLIO_open3(path, imode, perm);
2705 bool appended = FALSE;
2707 /* Cygwin wants its 'b' early. */
2709 mode = PerlIOStdio_mode(mode, tmode);
2711 stdio = PerlSIO_fopen(path, mode);
2715 f = PerlIO_allocate(aTHX);
2718 mode = PerlIOStdio_mode(mode, tmode);
2719 f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg);
2721 s = PerlIOSelf(f, PerlIOStdio);
2723 PerlIOUnix_refcnt_inc(fileno(s->stdio));
2735 if (*mode == IoTYPE_IMPLICIT) {
2742 stdio = PerlSIO_stdin;
2745 stdio = PerlSIO_stdout;
2748 stdio = PerlSIO_stderr;
2753 stdio = PerlSIO_fdopen(fd, mode =
2754 PerlIOStdio_mode(mode, tmode));
2758 f = PerlIO_allocate(aTHX);
2760 if ((f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg))) {
2761 PerlIOStdio *s = PerlIOSelf(f, PerlIOStdio);
2763 PerlIOUnix_refcnt_inc(fileno(s->stdio));
2773 PerlIOStdio_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2775 /* This assumes no layers underneath - which is what
2776 happens, but is not how I remember it. NI-S 2001/10/16
2778 if ((f = PerlIOBase_dup(aTHX_ f, o, param, flags))) {
2779 FILE *stdio = PerlIOSelf(o, PerlIOStdio)->stdio;
2780 const int fd = fileno(stdio);
2782 if (flags & PERLIO_DUP_FD) {
2783 const int dfd = PerlLIO_dup(fileno(stdio));
2785 stdio = PerlSIO_fdopen(dfd, PerlIO_modestr(o,mode));
2789 /* FIXME: To avoid messy error recovery if dup fails
2790 re-use the existing stdio as though flag was not set
2794 stdio = PerlSIO_fdopen(fd, PerlIO_modestr(o,mode));
2796 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2797 PerlIOUnix_refcnt_inc(fileno(stdio));
2803 PerlIOStdio_invalidate_fileno(pTHX_ FILE *f)
2805 /* XXX this could use PerlIO_canset_fileno() and
2806 * PerlIO_set_fileno() support from Configure
2808 # if defined(__UCLIBC__)
2809 /* uClibc must come before glibc because it defines __GLIBC__ as well. */
2812 # elif defined(__GLIBC__)
2813 /* There may be a better way for GLIBC:
2814 - libio.h defines a flag to not close() on cleanup
2818 # elif defined(__sun__)
2820 /* On solaris, if _LP64 is defined, the FILE structure is this:
2826 * It turns out that the fd is stored in the top 32 bits of
2827 * file->__pad[4]. The lower 32 bits contain flags. file->pad[5] appears
2828 * to contain a pointer or offset into another structure. All the
2829 * remaining fields are zero.
2831 * We set the top bits to -1 (0xFFFFFFFF).
2833 f->__pad[4] |= 0xffffffff00000000L;
2834 assert(fileno(f) == 0xffffffff);
2835 # else /* !defined(_LP64) */
2836 /* _file is just a unsigned char :-(
2837 Not clear why we dup() rather than using -1
2838 even if that would be treated as 0xFF - so will
2841 f->_file = PerlLIO_dup(fileno(f));
2842 # endif /* defined(_LP64) */
2844 # elif defined(__hpux)
2848 /* Next one ->_file seems to be a reasonable fallback, i.e. if
2849 your platform does not have special entry try this one.
2850 [For OSF only have confirmation for Tru64 (alpha)
2851 but assume other OSFs will be similar.]
2853 # elif defined(_AIX) || defined(__osf__) || defined(__irix__)
2856 # elif defined(__FreeBSD__)
2857 /* There may be a better way on FreeBSD:
2858 - we could insert a dummy func in the _close function entry
2859 f->_close = (int (*)(void *)) dummy_close;
2863 # elif defined(__OpenBSD__)
2864 /* There may be a better way on OpenBSD:
2865 - we could insert a dummy func in the _close function entry
2866 f->_close = (int (*)(void *)) dummy_close;
2870 # elif defined(__EMX__)
2871 /* f->_flags &= ~_IOOPEN; */ /* Will leak stream->_buffer */
2874 # elif defined(__CYGWIN__)
2875 /* There may be a better way on CYGWIN:
2876 - we could insert a dummy func in the _close function entry
2877 f->_close = (int (*)(void *)) dummy_close;
2881 # elif defined(WIN32)
2882 # if defined(__BORLANDC__)
2883 f->fd = PerlLIO_dup(fileno(f));
2884 # elif defined(UNDER_CE)
2885 /* WIN_CE does not have access to FILE internals, it hardly has FILE
2894 /* Sarathy's code did this - we fall back to a dup/dup2 hack
2895 (which isn't thread safe) instead
2897 # error "Don't know how to set FILE.fileno on your platform"
2905 PerlIOStdio_close(pTHX_ PerlIO *f)
2907 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
2913 const int fd = fileno(stdio);
2919 #ifdef SOCKS5_VERSION_NAME
2920 /* Socks lib overrides close() but stdio isn't linked to
2921 that library (though we are) - so we must call close()
2922 on sockets on stdio's behalf.
2925 Sock_size_t optlen = sizeof(int);
2926 if (getsockopt(fd, SOL_SOCKET, SO_TYPE, (void *) &optval, &optlen) == 0) {
2931 if (PerlIOUnix_refcnt_dec(fd) > 0) {
2932 /* File descriptor still in use */
2937 /* For STD* handles don't close the stdio at all
2938 this is because we have shared the FILE * too
2940 if (stdio == stdin) {
2941 /* Some stdios are buggy fflush-ing inputs */
2944 else if (stdio == stdout || stdio == stderr) {
2945 return PerlIO_flush(f);
2947 /* Tricky - must fclose(stdio) to free memory but not close(fd)
2948 Use Sarathy's trick from maint-5.6 to invalidate the
2949 fileno slot of the FILE *
2951 result = PerlIO_flush(f);
2953 if (!(invalidate = PerlIOStdio_invalidate_fileno(aTHX_ stdio))) {
2954 dupfd = PerlLIO_dup(fd);
2957 result = PerlSIO_fclose(stdio);
2958 /* We treat error from stdio as success if we invalidated
2959 errno may NOT be expected EBADF
2961 if (invalidate && result != 0) {
2966 /* in SOCKS case let close() determine return value */
2970 PerlLIO_dup2(dupfd,fd);
2971 PerlLIO_close(dupfd);
2978 PerlIOStdio_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
2980 FILE *s = PerlIOSelf(f, PerlIOStdio)->stdio;
2984 STDCHAR *buf = (STDCHAR *) vbuf;
2986 * Perl is expecting PerlIO_getc() to fill the buffer Linux's
2987 * stdio does not do that for fread()
2989 const int ch = PerlSIO_fgetc(s);
2996 got = PerlSIO_fread(vbuf, 1, count, s);
2997 if (got == 0 && PerlSIO_ferror(s))
2999 if (got >= 0 || errno != EINTR)
3002 SETERRNO(0,0); /* just in case */
3008 PerlIOStdio_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3011 FILE *s = PerlIOSelf(f, PerlIOStdio)->stdio;
3013 #ifdef STDIO_BUFFER_WRITABLE
3014 if (PerlIO_fast_gets(f) && PerlIO_has_base(f)) {
3015 STDCHAR *buf = ((STDCHAR *) vbuf) + count;
3016 STDCHAR *base = PerlIO_get_base(f);
3017 SSize_t cnt = PerlIO_get_cnt(f);
3018 STDCHAR *ptr = PerlIO_get_ptr(f);
3019 SSize_t avail = ptr - base;
3021 if (avail > count) {
3025 Move(buf-avail,ptr,avail,STDCHAR);
3028 PerlIO_set_ptrcnt(f,ptr,cnt+avail);
3029 if (PerlSIO_feof(s) && unread >= 0)
3030 PerlSIO_clearerr(s);
3035 if (PerlIO_has_cntptr(f)) {
3036 /* We can get pointer to buffer but not its base
3037 Do ungetc() but check chars are ending up in the
3040 STDCHAR *eptr = (STDCHAR*)PerlSIO_get_ptr(s);
3041 STDCHAR *buf = ((STDCHAR *) vbuf) + count;
3043 const int ch = *--buf & 0xFF;
3044 if (ungetc(ch,s) != ch) {
3045 /* ungetc did not work */
3048 if ((STDCHAR*)PerlSIO_get_ptr(s) != --eptr || ((*eptr & 0xFF) != ch)) {
3049 /* Did not change pointer as expected */
3050 fgetc(s); /* get char back again */
3060 unread += PerlIOBase_unread(aTHX_ f, vbuf, count);
3066 PerlIOStdio_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3070 got = PerlSIO_fwrite(vbuf, 1, count,
3071 PerlIOSelf(f, PerlIOStdio)->stdio);
3072 if (got >= 0 || errno != EINTR)
3075 SETERRNO(0,0); /* just in case */
3081 PerlIOStdio_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3083 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3084 return PerlSIO_fseek(stdio, offset, whence);
3088 PerlIOStdio_tell(pTHX_ PerlIO *f)
3090 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3091 return PerlSIO_ftell(stdio);
3095 PerlIOStdio_flush(pTHX_ PerlIO *f)
3097 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3098 if (PerlIOBase(f)->flags & PERLIO_F_CANWRITE) {
3099 return PerlSIO_fflush(stdio);
3104 * FIXME: This discards ungetc() and pre-read stuff which is not
3105 * right if this is just a "sync" from a layer above Suspect right
3106 * design is to do _this_ but not have layer above flush this
3107 * layer read-to-read
3110 * Not writeable - sync by attempting a seek
3113 if (PerlSIO_fseek(stdio, (Off_t) 0, SEEK_CUR) != 0)
3121 PerlIOStdio_eof(pTHX_ PerlIO *f)
3123 return PerlSIO_feof(PerlIOSelf(f, PerlIOStdio)->stdio);
3127 PerlIOStdio_error(pTHX_ PerlIO *f)
3129 return PerlSIO_ferror(PerlIOSelf(f, PerlIOStdio)->stdio);
3133 PerlIOStdio_clearerr(pTHX_ PerlIO *f)
3135 PerlSIO_clearerr(PerlIOSelf(f, PerlIOStdio)->stdio);
3139 PerlIOStdio_setlinebuf(pTHX_ PerlIO *f)
3141 #ifdef HAS_SETLINEBUF
3142 PerlSIO_setlinebuf(PerlIOSelf(f, PerlIOStdio)->stdio);
3144 PerlSIO_setvbuf(PerlIOSelf(f, PerlIOStdio)->stdio, Nullch, _IOLBF, 0);
3150 PerlIOStdio_get_base(pTHX_ PerlIO *f)
3152 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3153 return (STDCHAR*)PerlSIO_get_base(stdio);
3157 PerlIOStdio_get_bufsiz(pTHX_ PerlIO *f)
3159 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3160 return PerlSIO_get_bufsiz(stdio);
3164 #ifdef USE_STDIO_PTR
3166 PerlIOStdio_get_ptr(pTHX_ PerlIO *f)
3168 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3169 return (STDCHAR*)PerlSIO_get_ptr(stdio);
3173 PerlIOStdio_get_cnt(pTHX_ PerlIO *f)
3175 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3176 return PerlSIO_get_cnt(stdio);
3180 PerlIOStdio_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
3182 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3184 #ifdef STDIO_PTR_LVALUE
3185 PerlSIO_set_ptr(stdio, (void*)ptr); /* LHS STDCHAR* cast non-portable */
3186 #ifdef STDIO_PTR_LVAL_SETS_CNT
3187 if (PerlSIO_get_cnt(stdio) != (cnt)) {
3188 assert(PerlSIO_get_cnt(stdio) == (cnt));
3191 #if (!defined(STDIO_PTR_LVAL_NOCHANGE_CNT))
3193 * Setting ptr _does_ change cnt - we are done
3197 #else /* STDIO_PTR_LVALUE */
3199 #endif /* STDIO_PTR_LVALUE */
3202 * Now (or only) set cnt
3204 #ifdef STDIO_CNT_LVALUE
3205 PerlSIO_set_cnt(stdio, cnt);
3206 #else /* STDIO_CNT_LVALUE */
3207 #if (defined(STDIO_PTR_LVALUE) && defined(STDIO_PTR_LVAL_SETS_CNT))
3208 PerlSIO_set_ptr(stdio,
3209 PerlSIO_get_ptr(stdio) + (PerlSIO_get_cnt(stdio) -
3211 #else /* STDIO_PTR_LVAL_SETS_CNT */
3213 #endif /* STDIO_PTR_LVAL_SETS_CNT */
3214 #endif /* STDIO_CNT_LVALUE */
3221 PerlIOStdio_fill(pTHX_ PerlIO *f)
3223 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3226 * fflush()ing read-only streams can cause trouble on some stdio-s
3228 if ((PerlIOBase(f)->flags & PERLIO_F_CANWRITE)) {
3229 if (PerlSIO_fflush(stdio) != 0)
3232 c = PerlSIO_fgetc(stdio);
3236 #if (defined(STDIO_PTR_LVALUE) && (defined(STDIO_CNT_LVALUE) || defined(STDIO_PTR_LVAL_SETS_CNT)))
3238 #ifdef STDIO_BUFFER_WRITABLE
3239 if (PerlIO_fast_gets(f) && PerlIO_has_base(f)) {
3240 /* Fake ungetc() to the real buffer in case system's ungetc
3243 STDCHAR *base = (STDCHAR*)PerlSIO_get_base(stdio);
3244 SSize_t cnt = PerlSIO_get_cnt(stdio);
3245 STDCHAR *ptr = (STDCHAR*)PerlSIO_get_ptr(stdio);
3246 if (ptr == base+1) {
3247 *--ptr = (STDCHAR) c;
3248 PerlIOStdio_set_ptrcnt(aTHX_ f,ptr,cnt+1);
3249 if (PerlSIO_feof(stdio))
3250 PerlSIO_clearerr(stdio);
3256 if (PerlIO_has_cntptr(f)) {
3258 if (PerlIOStdio_unread(aTHX_ f,&ch,1) == 1) {
3265 /* An ungetc()d char is handled separately from the regular
3266 * buffer, so we stuff it in the buffer ourselves.
3267 * Should never get called as should hit code above
3269 *(--((*stdio)->_ptr)) = (unsigned char) c;
3272 /* If buffer snoop scheme above fails fall back to
3275 if (PerlSIO_ungetc(c, stdio) != c)
3283 PERLIO_FUNCS_DECL(PerlIO_stdio) = {
3284 sizeof(PerlIO_funcs),
3286 sizeof(PerlIOStdio),
3287 PERLIO_K_BUFFERED|PERLIO_K_RAW,
3291 PerlIOBase_binmode, /* binmode */
3305 PerlIOStdio_clearerr,
3306 PerlIOStdio_setlinebuf,
3308 PerlIOStdio_get_base,
3309 PerlIOStdio_get_bufsiz,
3314 #ifdef USE_STDIO_PTR
3315 PerlIOStdio_get_ptr,
3316 PerlIOStdio_get_cnt,
3317 # if defined(HAS_FAST_STDIO) && defined(USE_FAST_STDIO)
3318 PerlIOStdio_set_ptrcnt,
3321 # endif /* HAS_FAST_STDIO && USE_FAST_STDIO */
3326 #endif /* USE_STDIO_PTR */
3329 /* Note that calls to PerlIO_exportFILE() are reversed using
3330 * PerlIO_releaseFILE(), not importFILE. */
3332 PerlIO_exportFILE(PerlIO * f, const char *mode)
3336 if (PerlIOValid(f)) {
3339 if (!mode || !*mode) {
3340 mode = PerlIO_modestr(f, buf);
3342 stdio = PerlSIO_fdopen(PerlIO_fileno(f), mode);
3346 /* De-link any lower layers so new :stdio sticks */
3348 if ((f2 = PerlIO_push(aTHX_ f, PERLIO_FUNCS_CAST(&PerlIO_stdio), buf, Nullsv))) {
3349 PerlIOStdio *s = PerlIOSelf((f = f2), PerlIOStdio);
3351 /* Link previous lower layers under new one */
3355 /* restore layers list */
3365 PerlIO_findFILE(PerlIO *f)
3369 if (l->tab == &PerlIO_stdio) {
3370 PerlIOStdio *s = PerlIOSelf(&l, PerlIOStdio);
3373 l = *PerlIONext(&l);
3375 /* Uses fallback "mode" via PerlIO_modestr() in PerlIO_exportFILE */
3376 return PerlIO_exportFILE(f, Nullch);
3379 /* Use this to reverse PerlIO_exportFILE calls. */
3381 PerlIO_releaseFILE(PerlIO *p, FILE *f)
3386 if (l->tab == &PerlIO_stdio) {
3387 PerlIOStdio *s = PerlIOSelf(&l, PerlIOStdio);
3388 if (s->stdio == f) {
3390 PerlIO_pop(aTHX_ p);
3399 /*--------------------------------------------------------------------------------------*/
3401 * perlio buffer layer
3405 PerlIOBuf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
3407 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3408 const int fd = PerlIO_fileno(f);
3409 if (fd >= 0 && PerlLIO_isatty(fd)) {
3410 PerlIOBase(f)->flags |= PERLIO_F_LINEBUF | PERLIO_F_TTY;
3412 if (*PerlIONext(f)) {
3413 const Off_t posn = PerlIO_tell(PerlIONext(f));
3414 if (posn != (Off_t) - 1) {
3418 return PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
3422 PerlIOBuf_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
3423 IV n, const char *mode, int fd, int imode, int perm,
3424 PerlIO *f, int narg, SV **args)
3426 if (PerlIOValid(f)) {
3427 PerlIO *next = PerlIONext(f);
3429 PerlIO_layer_fetch(aTHX_ layers, n - 1, PerlIOBase(next)->tab);
3430 if (tab && tab->Open)
3432 (*tab->Open)(aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
3434 if (!next || (*PerlIOBase(f)->tab->Pushed) (aTHX_ f, mode, PerlIOArg, self) != 0) {
3439 PerlIO_funcs *tab = PerlIO_layer_fetch(aTHX_ layers, n - 1, PerlIO_default_btm());
3441 if (*mode == IoTYPE_IMPLICIT) {
3447 if (tab && tab->Open)
3448 f = (*tab->Open)(aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
3451 SETERRNO(EINVAL, LIB_INVARG);
3453 if (PerlIO_push(aTHX_ f, self, mode, PerlIOArg) == 0) {
3455 * if push fails during open, open fails. close will pop us.
3460 fd = PerlIO_fileno(f);
3461 if (init && fd == 2) {
3463 * Initial stderr is unbuffered
3465 PerlIOBase(f)->flags |= PERLIO_F_UNBUF;
3467 #ifdef PERLIO_USING_CRLF
3468 # ifdef PERLIO_IS_BINMODE_FD
3469 if (PERLIO_IS_BINMODE_FD(fd))
3470 PerlIO_binmode(aTHX_ f, '<'/*not used*/, O_BINARY, Nullch);
3474 * do something about failing setmode()? --jhi
3476 PerlLIO_setmode(fd, O_BINARY);
3485 * This "flush" is akin to sfio's sync in that it handles files in either
3486 * read or write state. For write state, we put the postponed data through
3487 * the next layers. For read state, we seek() the next layers to the
3488 * offset given by current position in the buffer, and discard the buffer
3489 * state (XXXX supposed to be for seek()able buffers only, but now it is done
3490 * in any case?). Then the pass the stick further in chain.
3493 PerlIOBuf_flush(pTHX_ PerlIO *f)
3495 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3497 PerlIO *n = PerlIONext(f);
3498 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF) {
3500 * write() the buffer
3502 const STDCHAR *buf = b->buf;
3503 const STDCHAR *p = buf;
3504 while (p < b->ptr) {
3505 SSize_t count = PerlIO_write(n, p, b->ptr - p);
3509 else if (count < 0 || PerlIO_error(n)) {
3510 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
3515 b->posn += (p - buf);
3517 else if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3518 STDCHAR *buf = PerlIO_get_base(f);
3520 * Note position change
3522 b->posn += (b->ptr - buf);
3523 if (b->ptr < b->end) {
3524 /* We did not consume all of it - try and seek downstream to
3525 our logical position
3527 if (PerlIOValid(n) && PerlIO_seek(n, b->posn, SEEK_SET) == 0) {
3528 /* Reload n as some layers may pop themselves on seek */
3529 b->posn = PerlIO_tell(n = PerlIONext(f));
3532 /* Seek failed (e.g. pipe or tty). Do NOT clear buffer or pre-read
3533 data is lost for good - so return saying "ok" having undone
3536 b->posn -= (b->ptr - buf);
3541 b->ptr = b->end = b->buf;
3542 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3543 /* We check for Valid because of dubious decision to make PerlIO_flush(NULL) flush all */
3544 if (PerlIOValid(n) && PerlIO_flush(n) != 0)
3549 /* This discards the content of the buffer after b->ptr, and rereads
3550 * the buffer from the position off in the layer downstream; here off
3551 * is at offset corresponding to b->ptr - b->buf.
3554 PerlIOBuf_fill(pTHX_ PerlIO *f)
3556 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3557 PerlIO *n = PerlIONext(f);
3560 * Down-stream flush is defined not to loose read data so is harmless.
3561 * we would not normally be fill'ing if there was data left in anycase.
3563 if (PerlIO_flush(f) != 0) /* XXXX Check that its seek() succeeded?! */
3565 if (PerlIOBase(f)->flags & PERLIO_F_TTY)
3566 PerlIOBase_flush_linebuf(aTHX);
3569 PerlIO_get_base(f); /* allocate via vtable */
3571 b->ptr = b->end = b->buf;
3573 if (!PerlIOValid(n)) {
3574 PerlIOBase(f)->flags |= PERLIO_F_EOF;
3578 if (PerlIO_fast_gets(n)) {
3580 * Layer below is also buffered. We do _NOT_ want to call its
3581 * ->Read() because that will loop till it gets what we asked for
3582 * which may hang on a pipe etc. Instead take anything it has to
3583 * hand, or ask it to fill _once_.
3585 avail = PerlIO_get_cnt(n);
3587 avail = PerlIO_fill(n);
3589 avail = PerlIO_get_cnt(n);
3591 if (!PerlIO_error(n) && PerlIO_eof(n))
3596 STDCHAR *ptr = PerlIO_get_ptr(n);
3597 SSize_t cnt = avail;
3598 if (avail > (SSize_t)b->bufsiz)
3600 Copy(ptr, b->buf, avail, STDCHAR);
3601 PerlIO_set_ptrcnt(n, ptr + avail, cnt - avail);
3605 avail = PerlIO_read(n, b->ptr, b->bufsiz);
3609 PerlIOBase(f)->flags |= PERLIO_F_EOF;
3611 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
3614 b->end = b->buf + avail;
3615 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3620 PerlIOBuf_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
3622 if (PerlIOValid(f)) {
3623 const PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3626 return PerlIOBase_read(aTHX_ f, vbuf, count);
3632 PerlIOBuf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3634 const STDCHAR *buf = (const STDCHAR *) vbuf + count;
3635 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3638 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
3643 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3645 * Buffer is already a read buffer, we can overwrite any chars
3646 * which have been read back to buffer start
3648 avail = (b->ptr - b->buf);
3652 * Buffer is idle, set it up so whole buffer is available for
3656 b->end = b->buf + avail;
3658 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3660 * Buffer extends _back_ from where we are now
3662 b->posn -= b->bufsiz;
3664 if (avail > (SSize_t) count) {
3666 * If we have space for more than count, just move count
3674 * In simple stdio-like ungetc() case chars will be already
3677 if (buf != b->ptr) {
3678 Copy(buf, b->ptr, avail, STDCHAR);
3682 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
3686 unread += PerlIOBase_unread(aTHX_ f, vbuf, count);
3692 PerlIOBuf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3694 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3695 const STDCHAR *buf = (const STDCHAR *) vbuf;
3696 const STDCHAR *flushptr = buf;
3700 if (!(PerlIOBase(f)->flags & PERLIO_F_CANWRITE))
3702 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3703 if (PerlIO_flush(f) != 0) {
3707 if (PerlIOBase(f)->flags & PERLIO_F_LINEBUF) {
3708 flushptr = buf + count;
3709 while (flushptr > buf && *(flushptr - 1) != '\n')
3713 SSize_t avail = b->bufsiz - (b->ptr - b->buf);
3714 if ((SSize_t) count < avail)
3716 if (flushptr > buf && flushptr <= buf + avail)
3717 avail = flushptr - buf;
3718 PerlIOBase(f)->flags |= PERLIO_F_WRBUF;
3720 Copy(buf, b->ptr, avail, STDCHAR);
3725 if (buf == flushptr)
3728 if (b->ptr >= (b->buf + b->bufsiz))
3731 if (PerlIOBase(f)->flags & PERLIO_F_UNBUF)
3737 PerlIOBuf_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3740 if ((code = PerlIO_flush(f)) == 0) {
3741 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
3742 code = PerlIO_seek(PerlIONext(f), offset, whence);
3744 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3745 b->posn = PerlIO_tell(PerlIONext(f));
3752 PerlIOBuf_tell(pTHX_ PerlIO *f)
3754 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3756 * b->posn is file position where b->buf was read, or will be written
3758 Off_t posn = b->posn;
3759 if ((PerlIOBase(f)->flags & PERLIO_F_APPEND) &&
3760 (PerlIOBase(f)->flags & PERLIO_F_WRBUF)) {
3762 /* As O_APPEND files are normally shared in some sense it is better
3767 /* when file is NOT shared then this is sufficient */
3768 PerlIO_seek(PerlIONext(f),0, SEEK_END);
3770 posn = b->posn = PerlIO_tell(PerlIONext(f));
3774 * If buffer is valid adjust position by amount in buffer
3776 posn += (b->ptr - b->buf);
3782 PerlIOBuf_popped(pTHX_ PerlIO *f)
3784 const IV code = PerlIOBase_popped(aTHX_ f);
3785 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3786 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
3790 b->ptr = b->end = b->buf;
3791 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3796 PerlIOBuf_close(pTHX_ PerlIO *f)
3798 const IV code = PerlIOBase_close(aTHX_ f);
3799 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3800 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
3804 b->ptr = b->end = b->buf;
3805 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3810 PerlIOBuf_get_ptr(pTHX_ PerlIO *f)
3812 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3819 PerlIOBuf_get_cnt(pTHX_ PerlIO *f)
3821 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3824 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF)
3825 return (b->end - b->ptr);
3830 PerlIOBuf_get_base(pTHX_ PerlIO *f)
3832 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3836 b->buf = Newxz(b->buf,b->bufsiz, STDCHAR);
3838 b->buf = (STDCHAR *) & b->oneword;
3839 b->bufsiz = sizeof(b->oneword);
3848 PerlIOBuf_bufsiz(pTHX_ PerlIO *f)
3850 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3853 return (b->end - b->buf);
3857 PerlIOBuf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
3859 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3863 if (PerlIO_get_cnt(f) != cnt || b->ptr < b->buf) {
3864 assert(PerlIO_get_cnt(f) == cnt);
3865 assert(b->ptr >= b->buf);
3867 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3871 PerlIOBuf_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
3873 return PerlIOBase_dup(aTHX_ f, o, param, flags);
3878 PERLIO_FUNCS_DECL(PerlIO_perlio) = {
3879 sizeof(PerlIO_funcs),
3882 PERLIO_K_BUFFERED|PERLIO_K_RAW,
3886 PerlIOBase_binmode, /* binmode */
3900 PerlIOBase_clearerr,
3901 PerlIOBase_setlinebuf,
3906 PerlIOBuf_set_ptrcnt,
3909 /*--------------------------------------------------------------------------------------*/
3911 * Temp layer to hold unread chars when cannot do it any other way
3915 PerlIOPending_fill(pTHX_ PerlIO *f)
3918 * Should never happen
3925 PerlIOPending_close(pTHX_ PerlIO *f)
3928 * A tad tricky - flush pops us, then we close new top
3931 return PerlIO_close(f);
3935 PerlIOPending_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3938 * A tad tricky - flush pops us, then we seek new top
3941 return PerlIO_seek(f, offset, whence);
3946 PerlIOPending_flush(pTHX_ PerlIO *f)
3948 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3949 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
3953 PerlIO_pop(aTHX_ f);
3958 PerlIOPending_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
3964 PerlIOBuf_set_ptrcnt(aTHX_ f, ptr, cnt);
3969 PerlIOPending_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
3971 const IV code = PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
3972 PerlIOl *l = PerlIOBase(f);
3974 * Our PerlIO_fast_gets must match what we are pushed on, or sv_gets()
3975 * etc. get muddled when it changes mid-string when we auto-pop.
3977 l->flags = (l->flags & ~(PERLIO_F_FASTGETS | PERLIO_F_UTF8)) |
3978 (PerlIOBase(PerlIONext(f))->
3979 flags & (PERLIO_F_FASTGETS | PERLIO_F_UTF8));
3984 PerlIOPending_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
3986 SSize_t avail = PerlIO_get_cnt(f);
3988 if ((SSize_t)count < avail)
3991 got = PerlIOBuf_read(aTHX_ f, vbuf, avail);
3992 if (got >= 0 && got < (SSize_t)count) {
3993 const SSize_t more =
3994 PerlIO_read(f, ((STDCHAR *) vbuf) + got, count - got);
3995 if (more >= 0 || got == 0)
4001 PERLIO_FUNCS_DECL(PerlIO_pending) = {
4002 sizeof(PerlIO_funcs),
4005 PERLIO_K_BUFFERED|PERLIO_K_RAW, /* not sure about RAW here */
4006 PerlIOPending_pushed,
4009 PerlIOBase_binmode, /* binmode */
4018 PerlIOPending_close,
4019 PerlIOPending_flush,
4023 PerlIOBase_clearerr,
4024 PerlIOBase_setlinebuf,
4029 PerlIOPending_set_ptrcnt,
4034 /*--------------------------------------------------------------------------------------*/
4036 * crlf - translation On read translate CR,LF to "\n" we do this by
4037 * overriding ptr/cnt entries to hand back a line at a time and keeping a
4038 * record of which nl we "lied" about. On write translate "\n" to CR,LF
4040 * c->nl points on the first byte of CR LF pair when it is temporarily
4041 * replaced by LF, or to the last CR of the buffer. In the former case
4042 * the caller thinks that the buffer ends at c->nl + 1, in the latter
4043 * that it ends at c->nl; these two cases can be distinguished by
4044 * *c->nl. c->nl is set during _getcnt() call, and unset during
4045 * _unread() and _flush() calls.
4046 * It only matters for read operations.
4050 PerlIOBuf base; /* PerlIOBuf stuff */
4051 STDCHAR *nl; /* Position of crlf we "lied" about in the
4056 PerlIOCrlf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
4059 PerlIOBase(f)->flags |= PERLIO_F_CRLF;
4060 code = PerlIOBuf_pushed(aTHX_ f, mode, arg, tab);
4062 PerlIO_debug("PerlIOCrlf_pushed f=%p %s %s fl=%08" UVxf "\n",
4063 f, PerlIOBase(f)->tab->name, (mode) ? mode : "(Null)",
4064 PerlIOBase(f)->flags);
4067 /* Enable the first CRLF capable layer you can find, but if none
4068 * found, the one we just pushed is fine. This results in at
4069 * any given moment at most one CRLF-capable layer being enabled
4070 * in the whole layer stack. */
4071 PerlIO *g = PerlIONext(f);
4073 PerlIOl *b = PerlIOBase(g);
4074 if (b && b->tab == &PerlIO_crlf) {
4075 if (!(b->flags & PERLIO_F_CRLF))
4076 b->flags |= PERLIO_F_CRLF;
4077 PerlIO_pop(aTHX_ f);
4088 PerlIOCrlf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4090 PerlIOCrlf *c = PerlIOSelf(f, PerlIOCrlf);
4091 if (c->nl) { /* XXXX Shouldn't it be done only if b->ptr > c->nl? */
4095 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF))
4096 return PerlIOBuf_unread(aTHX_ f, vbuf, count);
4098 const STDCHAR *buf = (const STDCHAR *) vbuf + count;
4099 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4101 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
4106 if (!(PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4107 b->end = b->ptr = b->buf + b->bufsiz;
4108 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4109 b->posn -= b->bufsiz;
4111 while (count > 0 && b->ptr > b->buf) {
4114 if (b->ptr - 2 >= b->buf) {
4121 /* If b->ptr - 1 == b->buf, we are undoing reading 0xa */
4122 *--(b->ptr) = 0xa; /* Works even if 0xa == '\r' */
4138 /* XXXX This code assumes that buffer size >=2, but does not check it... */
4140 PerlIOCrlf_get_cnt(pTHX_ PerlIO *f)
4142 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4145 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
4146 PerlIOCrlf *c = PerlIOSelf(f, PerlIOCrlf);
4147 if ((PerlIOBase(f)->flags & PERLIO_F_CRLF) && (!c->nl || *c->nl == 0xd)) {
4148 STDCHAR *nl = (c->nl) ? c->nl : b->ptr;
4150 while (nl < b->end && *nl != 0xd)
4152 if (nl < b->end && *nl == 0xd) {
4154 if (nl + 1 < b->end) {
4161 * Not CR,LF but just CR
4169 * Blast - found CR as last char in buffer
4174 * They may not care, defer work as long as
4178 return (nl - b->ptr);
4182 b->ptr++; /* say we have read it as far as
4183 * flush() is concerned */
4184 b->buf++; /* Leave space in front of buffer */
4185 /* Note as we have moved buf up flush's
4187 will naturally make posn point at CR
4189 b->bufsiz--; /* Buffer is thus smaller */
4190 code = PerlIO_fill(f); /* Fetch some more */
4191 b->bufsiz++; /* Restore size for next time */
4192 b->buf--; /* Point at space */
4193 b->ptr = nl = b->buf; /* Which is what we hand
4195 *nl = 0xd; /* Fill in the CR */
4197 goto test; /* fill() call worked */
4199 * CR at EOF - just fall through
4201 /* Should we clear EOF though ??? */
4206 return (((c->nl) ? (c->nl + 1) : b->end) - b->ptr);
4212 PerlIOCrlf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
4214 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4215 PerlIOCrlf *c = PerlIOSelf(f, PerlIOCrlf);
4221 if (ptr == b->end && *c->nl == 0xd) {
4222 /* Defered CR at end of buffer case - we lied about count */
4234 * Test code - delete when it works ...
4236 IV flags = PerlIOBase(f)->flags;
4237 STDCHAR *chk = (c->nl) ? (c->nl+1) : b->end;
4238 if (ptr+cnt == c->nl && c->nl+1 == b->end && *c->nl == 0xd) {
4239 /* Defered CR at end of buffer case - we lied about count */
4245 Perl_croak(aTHX_ "ptr wrong %p != %p fl=%08" UVxf
4246 " nl=%p e=%p for %d", ptr, chk, flags, c->nl,
4254 * They have taken what we lied about
4262 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4266 PerlIOCrlf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4268 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF))
4269 return PerlIOBuf_write(aTHX_ f, vbuf, count);
4271 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4272 const STDCHAR *buf = (const STDCHAR *) vbuf;
4273 const STDCHAR *ebuf = buf + count;
4276 if (!(PerlIOBase(f)->flags & PERLIO_F_CANWRITE))
4278 while (buf < ebuf) {
4279 STDCHAR *eptr = b->buf + b->bufsiz;
4280 PerlIOBase(f)->flags |= PERLIO_F_WRBUF;
4281 while (buf < ebuf && b->ptr < eptr) {
4283 if ((b->ptr + 2) > eptr) {
4291 *(b->ptr)++ = 0xd; /* CR */
4292 *(b->ptr)++ = 0xa; /* LF */
4294 if (PerlIOBase(f)->flags & PERLIO_F_LINEBUF) {
4304 if (b->ptr >= eptr) {
4310 if (PerlIOBase(f)->flags & PERLIO_F_UNBUF)
4312 return (buf - (STDCHAR *) vbuf);
4317 PerlIOCrlf_flush(pTHX_ PerlIO *f)
4319 PerlIOCrlf *c = PerlIOSelf(f, PerlIOCrlf);
4324 return PerlIOBuf_flush(aTHX_ f);
4328 PerlIOCrlf_binmode(pTHX_ PerlIO *f)
4330 if ((PerlIOBase(f)->flags & PERLIO_F_CRLF)) {
4331 /* In text mode - flush any pending stuff and flip it */
4332 PerlIOBase(f)->flags &= ~PERLIO_F_CRLF;
4333 #ifndef PERLIO_USING_CRLF
4334 /* CRLF is unusual case - if this is just the :crlf layer pop it */
4335 if (PerlIOBase(f)->tab == &PerlIO_crlf) {
4336 PerlIO_pop(aTHX_ f);
4343 PERLIO_FUNCS_DECL(PerlIO_crlf) = {
4344 sizeof(PerlIO_funcs),
4347 PERLIO_K_BUFFERED | PERLIO_K_CANCRLF | PERLIO_K_RAW,
4349 PerlIOBuf_popped, /* popped */
4351 PerlIOCrlf_binmode, /* binmode */
4355 PerlIOBuf_read, /* generic read works with ptr/cnt lies */
4356 PerlIOCrlf_unread, /* Put CR,LF in buffer for each '\n' */
4357 PerlIOCrlf_write, /* Put CR,LF in buffer for each '\n' */
4365 PerlIOBase_clearerr,
4366 PerlIOBase_setlinebuf,
4371 PerlIOCrlf_set_ptrcnt,
4375 /*--------------------------------------------------------------------------------------*/
4377 * mmap as "buffer" layer
4381 PerlIOBuf base; /* PerlIOBuf stuff */
4382 Mmap_t mptr; /* Mapped address */
4383 Size_t len; /* mapped length */
4384 STDCHAR *bbuf; /* malloced buffer if map fails */
4388 PerlIOMmap_map(pTHX_ PerlIO *f)
4391 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4392 const IV flags = PerlIOBase(f)->flags;
4396 if (flags & PERLIO_F_CANREAD) {
4397 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4398 const int fd = PerlIO_fileno(f);
4400 code = Fstat(fd, &st);
4401 if (code == 0 && S_ISREG(st.st_mode)) {
4402 SSize_t len = st.st_size - b->posn;
4405 if (PL_mmap_page_size <= 0)
4406 Perl_croak(aTHX_ "panic: bad pagesize %" IVdf,
4410 * This is a hack - should never happen - open should
4413 b->posn = PerlIO_tell(PerlIONext(f));
4415 posn = (b->posn / PL_mmap_page_size) * PL_mmap_page_size;
4416 len = st.st_size - posn;
4417 m->mptr = mmap(NULL, len, PROT_READ, MAP_SHARED, fd, posn);
4418 if (m->mptr && m->mptr != (Mmap_t) - 1) {
4419 #if 0 && defined(HAS_MADVISE) && defined(MADV_SEQUENTIAL)
4420 madvise(m->mptr, len, MADV_SEQUENTIAL);
4422 #if 0 && defined(HAS_MADVISE) && defined(MADV_WILLNEED)
4423 madvise(m->mptr, len, MADV_WILLNEED);
4425 PerlIOBase(f)->flags =
4426 (flags & ~PERLIO_F_EOF) | PERLIO_F_RDBUF;
4427 b->end = ((STDCHAR *) m->mptr) + len;
4428 b->buf = ((STDCHAR *) m->mptr) + (b->posn - posn);
4437 PerlIOBase(f)->flags =
4438 flags | PERLIO_F_EOF | PERLIO_F_RDBUF;
4440 b->ptr = b->end = b->ptr;
4449 PerlIOMmap_unmap(pTHX_ PerlIO *f)
4451 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4452 PerlIOBuf *b = &m->base;
4456 code = munmap(m->mptr, m->len);
4460 if (PerlIO_seek(PerlIONext(f), b->posn, SEEK_SET) != 0)
4463 b->ptr = b->end = b->buf;
4464 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
4470 PerlIOMmap_get_base(pTHX_ PerlIO *f)
4472 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4473 PerlIOBuf *b = &m->base;
4474 if (b->buf && (PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4476 * Already have a readbuffer in progress
4482 * We have a write buffer or flushed PerlIOBuf read buffer
4484 m->bbuf = b->buf; /* save it in case we need it again */
4485 b->buf = NULL; /* Clear to trigger below */
4488 PerlIOMmap_map(aTHX_ f); /* Try and map it */
4491 * Map did not work - recover PerlIOBuf buffer if we have one
4496 b->ptr = b->end = b->buf;
4499 return PerlIOBuf_get_base(aTHX_ f);
4503 PerlIOMmap_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4505 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4506 PerlIOBuf *b = &m->base;
4507 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
4509 if (b->ptr && (b->ptr - count) >= b->buf
4510 && memEQ(b->ptr - count, vbuf, count)) {
4512 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
4517 * Loose the unwritable mapped buffer
4521 * If flush took the "buffer" see if we have one from before
4523 if (!b->buf && m->bbuf)
4526 PerlIOBuf_get_base(aTHX_ f);
4530 return PerlIOBuf_unread(aTHX_ f, vbuf, count);
4534 PerlIOMmap_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4536 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4537 PerlIOBuf * const b = &m->base;
4539 if (!b->buf || !(PerlIOBase(f)->flags & PERLIO_F_WRBUF)) {
4541 * No, or wrong sort of, buffer
4544 if (PerlIOMmap_unmap(aTHX_ f) != 0)
4548 * If unmap took the "buffer" see if we have one from before
4550 if (!b->buf && m->bbuf)
4553 PerlIOBuf_get_base(aTHX_ f);
4557 return PerlIOBuf_write(aTHX_ f, vbuf, count);
4561 PerlIOMmap_flush(pTHX_ PerlIO *f)
4563 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4564 PerlIOBuf *b = &m->base;
4565 IV code = PerlIOBuf_flush(aTHX_ f);
4567 * Now we are "synced" at PerlIOBuf level
4574 if (PerlIOMmap_unmap(aTHX_ f) != 0)
4579 * We seem to have a PerlIOBuf buffer which was not mapped
4580 * remember it in case we need one later
4589 PerlIOMmap_fill(pTHX_ PerlIO *f)
4591 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4592 IV code = PerlIO_flush(f);
4593 if (code == 0 && !b->buf) {
4594 code = PerlIOMmap_map(aTHX_ f);
4596 if (code == 0 && !(PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4597 code = PerlIOBuf_fill(aTHX_ f);
4603 PerlIOMmap_close(pTHX_ PerlIO *f)
4605 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4606 PerlIOBuf *b = &m->base;
4607 IV code = PerlIO_flush(f);
4611 b->ptr = b->end = b->buf;
4613 if (PerlIOBuf_close(aTHX_ f) != 0)
4619 PerlIOMmap_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
4621 return PerlIOBase_dup(aTHX_ f, o, param, flags);
4625 PERLIO_FUNCS_DECL(PerlIO_mmap) = {
4626 sizeof(PerlIO_funcs),
4629 PERLIO_K_BUFFERED|PERLIO_K_RAW,
4633 PerlIOBase_binmode, /* binmode */
4647 PerlIOBase_clearerr,
4648 PerlIOBase_setlinebuf,
4649 PerlIOMmap_get_base,
4653 PerlIOBuf_set_ptrcnt,
4656 #endif /* HAS_MMAP */
4659 Perl_PerlIO_stdin(pTHX)
4662 PerlIO_stdstreams(aTHX);
4664 return &PL_perlio[1];
4668 Perl_PerlIO_stdout(pTHX)
4671 PerlIO_stdstreams(aTHX);
4673 return &PL_perlio[2];
4677 Perl_PerlIO_stderr(pTHX)
4680 PerlIO_stdstreams(aTHX);
4682 return &PL_perlio[3];
4685 /*--------------------------------------------------------------------------------------*/
4688 PerlIO_getname(PerlIO *f, char *buf)
4693 bool exported = FALSE;
4694 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
4696 stdio = PerlIO_exportFILE(f,0);
4700 name = fgetname(stdio, buf);
4701 if (exported) PerlIO_releaseFILE(f,stdio);
4706 PERL_UNUSED_ARG(buf);
4707 Perl_croak(aTHX_ "Don't know how to get file name");
4713 /*--------------------------------------------------------------------------------------*/
4715 * Functions which can be called on any kind of PerlIO implemented in
4719 #undef PerlIO_fdopen
4721 PerlIO_fdopen(int fd, const char *mode)
4724 return PerlIO_openn(aTHX_ Nullch, mode, fd, 0, 0, NULL, 0, NULL);
4729 PerlIO_open(const char *path, const char *mode)
4732 SV *name = sv_2mortal(newSVpvn(path, strlen(path)));
4733 return PerlIO_openn(aTHX_ Nullch, mode, -1, 0, 0, NULL, 1, &name);
4736 #undef Perlio_reopen
4738 PerlIO_reopen(const char *path, const char *mode, PerlIO *f)
4741 SV *name = sv_2mortal(newSVpvn(path, strlen(path)));
4742 return PerlIO_openn(aTHX_ Nullch, mode, -1, 0, 0, f, 1, &name);
4747 PerlIO_getc(PerlIO *f)
4751 if ( 1 == PerlIO_read(f, buf, 1) ) {
4752 return (unsigned char) buf[0];
4757 #undef PerlIO_ungetc
4759 PerlIO_ungetc(PerlIO *f, int ch)
4764 if (PerlIO_unread(f, &buf, 1) == 1)
4772 PerlIO_putc(PerlIO *f, int ch)
4776 return PerlIO_write(f, &buf, 1);
4781 PerlIO_puts(PerlIO *f, const char *s)
4784 STRLEN len = strlen(s);
4785 return PerlIO_write(f, s, len);
4788 #undef PerlIO_rewind
4790 PerlIO_rewind(PerlIO *f)
4793 PerlIO_seek(f, (Off_t) 0, SEEK_SET);
4797 #undef PerlIO_vprintf
4799 PerlIO_vprintf(PerlIO *f, const char *fmt, va_list ap)
4802 SV *sv = newSVpvn("", 0);
4808 Perl_va_copy(ap, apc);
4809 sv_vcatpvf(sv, fmt, &apc);
4811 sv_vcatpvf(sv, fmt, &ap);
4813 s = SvPV_const(sv, len);
4814 wrote = PerlIO_write(f, s, len);
4819 #undef PerlIO_printf
4821 PerlIO_printf(PerlIO *f, const char *fmt, ...)
4826 result = PerlIO_vprintf(f, fmt, ap);
4831 #undef PerlIO_stdoutf
4833 PerlIO_stdoutf(const char *fmt, ...)
4839 result = PerlIO_vprintf(PerlIO_stdout(), fmt, ap);
4844 #undef PerlIO_tmpfile
4846 PerlIO_tmpfile(void)
4851 const int fd = win32_tmpfd();
4853 f = PerlIO_fdopen(fd, "w+b");
4855 # if defined(HAS_MKSTEMP) && ! defined(VMS) && ! defined(OS2)
4856 SV *sv = newSVpv("/tmp/PerlIO_XXXXXX", 0);
4858 * I have no idea how portable mkstemp() is ... NI-S
4860 const int fd = mkstemp(SvPVX(sv));
4862 f = PerlIO_fdopen(fd, "w+");
4864 PerlIOBase(f)->flags |= PERLIO_F_TEMP;
4865 PerlLIO_unlink(SvPVX_const(sv));
4868 # else /* !HAS_MKSTEMP, fallback to stdio tmpfile(). */
4869 FILE *stdio = PerlSIO_tmpfile();
4872 if ((f = PerlIO_push(aTHX_(PerlIO_allocate(aTHX)),
4873 PERLIO_FUNCS_CAST(&PerlIO_stdio),
4875 PerlIOStdio *s = PerlIOSelf(f, PerlIOStdio);
4881 # endif /* else HAS_MKSTEMP */
4882 #endif /* else WIN32 */
4889 #endif /* USE_SFIO */
4890 #endif /* PERLIO_IS_STDIO */
4892 /*======================================================================================*/
4894 * Now some functions in terms of above which may be needed even if we are
4895 * not in true PerlIO mode
4899 #undef PerlIO_setpos
4901 PerlIO_setpos(PerlIO *f, SV *pos)
4906 Off_t *posn = (Off_t *) SvPV(pos, len);
4907 if (f && len == sizeof(Off_t))
4908 return PerlIO_seek(f, *posn, SEEK_SET);
4910 SETERRNO(EINVAL, SS_IVCHAN);
4914 #undef PerlIO_setpos
4916 PerlIO_setpos(PerlIO *f, SV *pos)
4921 Fpos_t *fpos = (Fpos_t *) SvPV(pos, len);
4922 if (f && len == sizeof(Fpos_t)) {
4923 #if defined(USE_64_BIT_STDIO) && defined(USE_FSETPOS64)
4924 return fsetpos64(f, fpos);
4926 return fsetpos(f, fpos);
4930 SETERRNO(EINVAL, SS_IVCHAN);
4936 #undef PerlIO_getpos
4938 PerlIO_getpos(PerlIO *f, SV *pos)
4941 Off_t posn = PerlIO_tell(f);
4942 sv_setpvn(pos, (char *) &posn, sizeof(posn));
4943 return (posn == (Off_t) - 1) ? -1 : 0;
4946 #undef PerlIO_getpos
4948 PerlIO_getpos(PerlIO *f, SV *pos)
4953 #if defined(USE_64_BIT_STDIO) && defined(USE_FSETPOS64)
4954 code = fgetpos64(f, &fpos);
4956 code = fgetpos(f, &fpos);
4958 sv_setpvn(pos, (char *) &fpos, sizeof(fpos));
4963 #if (defined(PERLIO_IS_STDIO) || !defined(USE_SFIO)) && !defined(HAS_VPRINTF)
4966 vprintf(char *pat, char *args)
4968 _doprnt(pat, args, stdout);
4969 return 0; /* wrong, but perl doesn't use the return
4974 vfprintf(FILE *fd, char *pat, char *args)
4976 _doprnt(pat, args, fd);
4977 return 0; /* wrong, but perl doesn't use the return
4983 #ifndef PerlIO_vsprintf
4985 PerlIO_vsprintf(char *s, int n, const char *fmt, va_list ap)
4988 const int val = vsprintf(s, fmt, ap);
4990 if (strlen(s) >= (STRLEN) n) {
4992 (void) PerlIO_puts(Perl_error_log,
4993 "panic: sprintf overflow - memory corrupted!\n");
5001 #ifndef PerlIO_sprintf
5003 PerlIO_sprintf(char *s, int n, const char *fmt, ...)
5008 result = PerlIO_vsprintf(s, n, fmt, ap);
5016 * c-indentation-style: bsd
5018 * indent-tabs-mode: t
5021 * ex: set ts=8 sts=4 sw=4 noet: