2 * perlio.c Copyright (c) 1996-2002, 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.
13 * If we have ActivePerl-like PERL_IMPLICIT_SYS then we need a dTHX to get
14 * at the dispatch tables, even when we do not need it for other reasons.
15 * Invent a dSYS macro to abstract this out
17 #ifdef PERL_IMPLICIT_SYS
30 #define PERLIO_NOT_STDIO 0
31 #if !defined(PERLIO_IS_STDIO) && !defined(USE_SFIO)
37 * This file provides those parts of PerlIO abstraction
38 * which are not #defined in perlio.h.
39 * Which these are depends on various Configure #ifdef's
43 #define PERL_IN_PERLIO_C
46 #ifdef PERL_IMPLICIT_CONTEXT
53 /* Call the callback or PerlIOBase, and return failure. */
54 #define Perl_PerlIO_or_Base(f, callback, base, failure, args) \
55 if (PerlIOValid(f)) { \
56 PerlIO_funcs *tab = PerlIOBase(f)->tab; \
57 if (tab && tab->callback) \
58 return (*tab->callback) args; \
60 return PerlIOBase_ ## base args; \
63 SETERRNO(EBADF, SS_IVCHAN); \
66 /* Call the callback or fail, and return failure. */
67 #define Perl_PerlIO_or_fail(f, callback, failure, args) \
68 if (PerlIOValid(f)) { \
69 PerlIO_funcs *tab = PerlIOBase(f)->tab; \
70 if (tab && tab->callback) \
71 return (*tab->callback) args; \
72 SETERRNO(EINVAL, LIB_INVARG); \
75 SETERRNO(EBADF, SS_IVCHAN); \
78 /* Call the callback or PerlIOBase, and be void. */
79 #define Perl_PerlIO_or_Base_void(f, callback, base, args) \
80 if (PerlIOValid(f)) { \
81 PerlIO_funcs *tab = PerlIOBase(f)->tab; \
82 if (tab && tab->callback) \
83 (*tab->callback) args; \
85 PerlIOBase_ ## base args; \
86 SETERRNO(EINVAL, LIB_INVARG); \
89 SETERRNO(EBADF, SS_IVCHAN)
91 /* Call the callback or fail, and be void. */
92 #define Perl_PerlIO_or_fail_void(f, callback, args) \
93 if (PerlIOValid(f)) { \
94 PerlIO_funcs *tab = PerlIOBase(f)->tab; \
95 if (tab && tab->callback) \
96 (*tab->callback) args; \
97 SETERRNO(EINVAL, LIB_INVARG); \
100 SETERRNO(EBADF, SS_IVCHAN)
103 perlsio_binmode(FILE *fp, int iotype, int mode)
106 * This used to be contents of do_binmode in doio.c
109 # if defined(atarist) || defined(__MINT__)
112 ((FILE *) fp)->_flag |= _IOBIN;
114 ((FILE *) fp)->_flag &= ~_IOBIN;
121 if (PerlLIO_setmode(fp, mode) != -1) {
123 if (PerlLIO_setmode(fileno(fp), mode) != -1) {
125 # if defined(WIN32) && defined(__BORLANDC__)
127 * The translation mode of the stream is maintained independent of
128 * the translation mode of the fd in the Borland RTL (heavy
129 * digging through their runtime sources reveal). User has to set
130 * the mode explicitly for the stream (though they don't document
131 * this anywhere). GSAR 97-5-24
137 fp->flags &= ~_F_BIN;
145 # if defined(USEMYBINMODE)
147 if (my_binmode(fp, iotype, mode) != FALSE)
158 #define O_ACCMODE 3 /* Assume traditional implementation */
162 PerlIO_intmode2str(int rawmode, char *mode, int *writing)
164 int result = rawmode & O_ACCMODE;
169 ptype = IoTYPE_RDONLY;
172 ptype = IoTYPE_WRONLY;
180 *writing = (result != O_RDONLY);
182 if (result == O_RDONLY) {
186 else if (rawmode & O_APPEND) {
188 if (result != O_WRONLY)
193 if (result == O_WRONLY)
200 if (rawmode & O_BINARY)
206 #ifndef PERLIO_LAYERS
208 PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode, const char *names)
210 if (!names || !*names
211 || strEQ(names, ":crlf")
212 || strEQ(names, ":raw")
213 || strEQ(names, ":bytes")
217 Perl_croak(aTHX_ "Cannot apply \"%s\" in non-PerlIO perl", names);
225 PerlIO_destruct(pTHX)
230 PerlIO_binmode(pTHX_ PerlIO *fp, int iotype, int mode, const char *names)
235 return perlsio_binmode(fp, iotype, mode);
240 PerlIO_fdupopen(pTHX_ PerlIO *f, CLONE_PARAMS *param, int flags)
245 #ifdef PERL_IMPLICIT_SYS
246 return PerlSIO_fdupopen(f);
249 return win32_fdupopen(f);
252 int fd = PerlLIO_dup(PerlIO_fileno(f));
255 int omode = fcntl(fd, F_GETFL);
257 omode = djgpp_get_stream_mode(f);
259 PerlIO_intmode2str(omode,mode,NULL);
260 /* the r+ is a hack */
261 return PerlIO_fdopen(fd, mode);
266 SETERRNO(EBADF, SS_IVCHAN);
276 * De-mux PerlIO_openn() into fdopen, freopen and fopen type entries
280 PerlIO_openn(pTHX_ const char *layers, const char *mode, int fd,
281 int imode, int perm, PerlIO *old, int narg, SV **args)
285 Perl_croak(aTHX_ "More than one argument to open");
287 if (*args == &PL_sv_undef)
288 return PerlIO_tmpfile();
290 char *name = SvPV_nolen(*args);
292 fd = PerlLIO_open3(name, imode, perm);
294 return PerlIO_fdopen(fd, (char *) 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)
314 Perl_croak(aTHX_ "Usage class->find(name[,load])");
316 char *name = SvPV_nolen(ST(1));
317 ST(0) = (strEQ(name, "crlf")
318 || strEQ(name, "raw")) ? &PL_sv_yes : &PL_sv_undef;
325 Perl_boot_core_PerlIO(pTHX)
327 newXS("PerlIO::Layer::find", XS_PerlIO__Layer__find, __FILE__);
333 #ifdef PERLIO_IS_STDIO
339 * Does nothing (yet) except force this file to be included in perl
340 * binary. That allows this file to force inclusion of other functions
341 * that may be required by loadable extensions e.g. for
342 * FileHandle::tmpfile
346 #undef PerlIO_tmpfile
353 #else /* PERLIO_IS_STDIO */
361 * This section is just to make sure these functions get pulled in from
365 #undef PerlIO_tmpfile
376 * Force this file to be included in perl binary. Which allows this
377 * file to force inclusion of other functions that may be required by
378 * loadable extensions e.g. for FileHandle::tmpfile
382 * Hack sfio does its own 'autoflush' on stdout in common cases. Flush
383 * results in a lot of lseek()s to regular files and lot of small
386 sfset(sfstdout, SF_SHARE, 0);
389 /* This is not the reverse of PerlIO_exportFILE(), PerlIO_releaseFILE() is. */
391 PerlIO_importFILE(FILE *stdio, const char *mode)
393 int fd = fileno(stdio);
394 if (!mode || !*mode) {
397 return PerlIO_fdopen(fd, mode);
401 PerlIO_findFILE(PerlIO *pio)
403 int fd = PerlIO_fileno(pio);
404 FILE *f = fdopen(fd, "r+");
406 if (!f && errno == EINVAL)
408 if (!f && errno == EINVAL)
415 /*======================================================================================*/
417 * Implement all the PerlIO interface ourselves.
423 * We _MUST_ have <unistd.h> if we are using lseek() and may have large
430 #include <sys/mman.h>
434 void PerlIO_debug(const char *fmt, ...)
435 __attribute__ ((format(__printf__, 1, 2)));
438 PerlIO_debug(const char *fmt, ...)
445 char *s = PerlEnv_getenv("PERLIO_DEBUG");
447 dbg = PerlLIO_open3(s, O_WRONLY | O_CREAT | O_APPEND, 0666);
454 /* Use fixed buffer as sv_catpvf etc. needs SVs */
458 s = CopFILE(PL_curcop);
461 sprintf(buffer, "%s:%" IVdf " ", s, (IV) CopLINE(PL_curcop));
462 len = strlen(buffer);
463 vsprintf(buffer+len, fmt, ap);
464 PerlLIO_write(dbg, buffer, strlen(buffer));
466 SV *sv = newSVpvn("", 0);
469 s = CopFILE(PL_curcop);
472 Perl_sv_catpvf(aTHX_ sv, "%s:%" IVdf " ", s,
473 (IV) CopLINE(PL_curcop));
474 Perl_sv_vcatpvf(aTHX_ sv, fmt, &ap);
477 PerlLIO_write(dbg, s, len);
484 /*--------------------------------------------------------------------------------------*/
487 * Inner level routines
491 * Table of pointers to the PerlIO structs (malloc'ed)
493 #define PERLIO_TABLE_SIZE 64
496 PerlIO_allocate(pTHX)
499 * Find a free slot in the table, allocating new table as necessary
504 while ((f = *last)) {
506 last = (PerlIO **) (f);
507 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
513 Newz('I',f,PERLIO_TABLE_SIZE,PerlIO);
521 #undef PerlIO_fdupopen
523 PerlIO_fdupopen(pTHX_ PerlIO *f, CLONE_PARAMS *param, int flags)
525 if (PerlIOValid(f)) {
526 PerlIO_funcs *tab = PerlIOBase(f)->tab;
527 PerlIO_debug("fdupopen f=%p param=%p\n",(void*)f,(void*)param);
529 return (*tab->Dup)(aTHX_ PerlIO_allocate(aTHX), f, param, flags);
530 SETERRNO(EINVAL, LIB_INVARG);
533 SETERRNO(EBADF, SS_IVCHAN);
539 PerlIO_cleantable(pTHX_ PerlIO **tablep)
541 PerlIO *table = *tablep;
544 PerlIO_cleantable(aTHX_(PerlIO **) & (table[0]));
545 for (i = PERLIO_TABLE_SIZE - 1; i > 0; i--) {
546 PerlIO *f = table + i;
558 PerlIO_list_alloc(pTHX)
561 Newz('L', list, 1, PerlIO_list_t);
567 PerlIO_list_free(pTHX_ PerlIO_list_t *list)
570 if (--list->refcnt == 0) {
573 for (i = 0; i < list->cur; i++) {
574 if (list->array[i].arg)
575 SvREFCNT_dec(list->array[i].arg);
577 Safefree(list->array);
585 PerlIO_list_push(pTHX_ PerlIO_list_t *list, PerlIO_funcs *funcs, SV *arg)
588 if (list->cur >= list->len) {
591 Renew(list->array, list->len, PerlIO_pair_t);
593 New('l', list->array, list->len, PerlIO_pair_t);
595 p = &(list->array[list->cur++]);
597 if ((p->arg = arg)) {
603 PerlIO_clone_list(pTHX_ PerlIO_list_t *proto, CLONE_PARAMS *param)
605 PerlIO_list_t *list = (PerlIO_list_t *) NULL;
608 list = PerlIO_list_alloc(aTHX);
609 for (i=0; i < proto->cur; i++) {
611 if (proto->array[i].arg)
612 arg = PerlIO_sv_dup(aTHX_ proto->array[i].arg,param);
613 PerlIO_list_push(aTHX_ list, proto->array[i].funcs, arg);
620 PerlIO_clone(pTHX_ PerlInterpreter *proto, CLONE_PARAMS *param)
623 PerlIO **table = &proto->Iperlio;
626 PL_known_layers = PerlIO_clone_list(aTHX_ proto->Iknown_layers, param);
627 PL_def_layerlist = PerlIO_clone_list(aTHX_ proto->Idef_layerlist, param);
628 PerlIO_allocate(aTHX); /* root slot is never used */
629 PerlIO_debug("Clone %p from %p\n",aTHX,proto);
630 while ((f = *table)) {
632 table = (PerlIO **) (f++);
633 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
635 (void) fp_dup(f, 0, param);
644 PerlIO_destruct(pTHX)
646 PerlIO **table = &PL_perlio;
649 PerlIO_debug("Destruct %p\n",aTHX);
651 while ((f = *table)) {
653 table = (PerlIO **) (f++);
654 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
658 if (l->tab->kind & PERLIO_K_DESTRUCT) {
659 PerlIO_debug("Destruct popping %s\n", l->tab->name);
673 PerlIO_pop(pTHX_ PerlIO *f)
677 PerlIO_debug("PerlIO_pop f=%p %s\n", (void*)f, l->tab->name);
678 if (l->tab->Popped) {
680 * If popped returns non-zero do not free its layer structure
681 * it has either done so itself, or it is shared and still in
684 if ((*l->tab->Popped) (aTHX_ f) != 0)
692 /* Return as an array the stack of layers on a filehandle. Note that
693 * the stack is returned top-first in the array, and there are three
694 * times as many array elements as there are layers in the stack: the
695 * first element of a layer triplet is the name, the second one is the
696 * arguments, and the third one is the flags. */
699 PerlIO_get_layers(pTHX_ PerlIO *f)
703 if (PerlIOValid(f)) {
704 PerlIOl *l = PerlIOBase(f);
707 SV *name = l->tab && l->tab->name ?
708 newSVpv(l->tab->name, 0) : &PL_sv_undef;
709 SV *arg = l->tab && l->tab->Getarg ?
710 (*l->tab->Getarg)(aTHX_ &l, 0, 0) : &PL_sv_undef;
713 av_push(av, newSViv((IV)l->flags));
721 /*--------------------------------------------------------------------------------------*/
723 * XS Interface for perl code
727 PerlIO_find_layer(pTHX_ const char *name, STRLEN len, int load)
730 if ((SSize_t) len <= 0)
732 for (i = 0; i < PL_known_layers->cur; i++) {
733 PerlIO_funcs *f = PL_known_layers->array[i].funcs;
734 if (memEQ(f->name, name, len)) {
735 PerlIO_debug("%.*s => %p\n", (int) len, name, (void*)f);
739 if (load && PL_subname && PL_def_layerlist
740 && PL_def_layerlist->cur >= 2) {
741 if (PL_in_load_module) {
742 Perl_croak(aTHX_ "Recursive call to Perl_load_module in PerlIO_find_layer");
745 SV *pkgsv = newSVpvn("PerlIO", 6);
746 SV *layer = newSVpvn(name, len);
747 CV *cv = get_cv("PerlIO::Layer::NoWarnings", FALSE);
749 SAVEINT(PL_in_load_module);
751 SAVESPTR(PL_warnhook);
752 PL_warnhook = (SV *) cv;
756 * The two SVs are magically freed by load_module
758 Perl_load_module(aTHX_ 0, pkgsv, Nullsv, layer, Nullsv);
761 return PerlIO_find_layer(aTHX_ name, len, 0);
764 PerlIO_debug("Cannot find %.*s\n", (int) len, name);
768 #ifdef USE_ATTRIBUTES_FOR_PERLIO
771 perlio_mg_set(pTHX_ SV *sv, MAGIC *mg)
774 IO *io = GvIOn((GV *) SvRV(sv));
775 PerlIO *ifp = IoIFP(io);
776 PerlIO *ofp = IoOFP(io);
777 Perl_warn(aTHX_ "set %" SVf " %p %p %p", sv, io, ifp, ofp);
783 perlio_mg_get(pTHX_ SV *sv, MAGIC *mg)
786 IO *io = GvIOn((GV *) SvRV(sv));
787 PerlIO *ifp = IoIFP(io);
788 PerlIO *ofp = IoOFP(io);
789 Perl_warn(aTHX_ "get %" SVf " %p %p %p", sv, io, ifp, ofp);
795 perlio_mg_clear(pTHX_ SV *sv, MAGIC *mg)
797 Perl_warn(aTHX_ "clear %" SVf, sv);
802 perlio_mg_free(pTHX_ SV *sv, MAGIC *mg)
804 Perl_warn(aTHX_ "free %" SVf, sv);
808 MGVTBL perlio_vtab = {
816 XS(XS_io_MODIFY_SCALAR_ATTRIBUTES)
819 SV *sv = SvRV(ST(1));
824 sv_magic(sv, (SV *) av, PERL_MAGIC_ext, NULL, 0);
826 mg = mg_find(sv, PERL_MAGIC_ext);
827 mg->mg_virtual = &perlio_vtab;
829 Perl_warn(aTHX_ "attrib %" SVf, sv);
830 for (i = 2; i < items; i++) {
832 const char *name = SvPV(ST(i), len);
833 SV *layer = PerlIO_find_layer(aTHX_ name, len, 1);
835 av_push(av, SvREFCNT_inc(layer));
846 #endif /* USE_ATTIBUTES_FOR_PERLIO */
849 PerlIO_tab_sv(pTHX_ PerlIO_funcs *tab)
851 HV *stash = gv_stashpv("PerlIO::Layer", TRUE);
852 SV *sv = sv_bless(newRV_noinc(newSViv(PTR2IV(tab))), stash);
856 XS(XS_PerlIO__Layer__NoWarnings)
858 /* This is used as a %SIG{__WARN__} handler to supress warnings
859 during loading of layers.
863 PerlIO_debug("warning:%s\n",SvPV_nolen(ST(0)));
867 XS(XS_PerlIO__Layer__find)
871 Perl_croak(aTHX_ "Usage class->find(name[,load])");
874 char *name = SvPV(ST(1), len);
875 bool load = (items > 2) ? SvTRUE(ST(2)) : 0;
876 PerlIO_funcs *layer = PerlIO_find_layer(aTHX_ name, len, load);
878 (layer) ? sv_2mortal(PerlIO_tab_sv(aTHX_ layer)) :
885 PerlIO_define_layer(pTHX_ PerlIO_funcs *tab)
887 if (!PL_known_layers)
888 PL_known_layers = PerlIO_list_alloc(aTHX);
889 PerlIO_list_push(aTHX_ PL_known_layers, tab, Nullsv);
890 PerlIO_debug("define %s %p\n", tab->name, (void*)tab);
894 PerlIO_parse_layers(pTHX_ PerlIO_list_t *av, const char *names)
897 const char *s = names;
899 while (isSPACE(*s) || *s == ':')
904 const char *as = Nullch;
906 if (!isIDFIRST(*s)) {
908 * Message is consistent with how attribute lists are
909 * passed. Even though this means "foo : : bar" is
910 * seen as an invalid separator character.
912 char q = ((*s == '\'') ? '"' : '\'');
913 if (ckWARN(WARN_LAYER))
914 Perl_warner(aTHX_ packWARN(WARN_LAYER),
915 "perlio: invalid separator character %c%c%c in layer specification list %s",
917 SETERRNO(EINVAL, LIB_INVARG);
922 } while (isALNUM(*e));
938 * It's a nul terminated string, not allowed
939 * to \ the terminating null. Anything other
940 * character is passed over.
950 if (ckWARN(WARN_LAYER))
951 Perl_warner(aTHX_ packWARN(WARN_LAYER),
952 "perlio: argument list not closed for layer \"%.*s\"",
964 bool warn_layer = ckWARN(WARN_LAYER);
965 PerlIO_funcs *layer =
966 PerlIO_find_layer(aTHX_ s, llen, 1);
968 PerlIO_list_push(aTHX_ av, layer,
975 Perl_warner(aTHX_ packWARN(WARN_LAYER), "perlio: unknown layer \"%.*s\"",
988 PerlIO_default_buffer(pTHX_ PerlIO_list_t *av)
990 PerlIO_funcs *tab = &PerlIO_perlio;
991 #ifdef PERLIO_USING_CRLF
994 if (PerlIO_stdio.Set_ptrcnt)
997 PerlIO_debug("Pushing %s\n", tab->name);
998 PerlIO_list_push(aTHX_ av, PerlIO_find_layer(aTHX_ tab->name, 0, 0),
1003 PerlIO_arg_fetch(PerlIO_list_t *av, IV n)
1005 return av->array[n].arg;
1009 PerlIO_layer_fetch(pTHX_ PerlIO_list_t *av, IV n, PerlIO_funcs *def)
1011 if (n >= 0 && n < av->cur) {
1012 PerlIO_debug("Layer %" IVdf " is %s\n", n,
1013 av->array[n].funcs->name);
1014 return av->array[n].funcs;
1017 Perl_croak(aTHX_ "panic: PerlIO layer array corrupt");
1022 PerlIOPop_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1024 if (PerlIOValid(f)) {
1026 PerlIO_pop(aTHX_ f);
1032 PerlIO_funcs PerlIO_remove = {
1033 sizeof(PerlIO_funcs),
1036 PERLIO_K_DUMMY | PERLIO_K_UTF8,
1054 NULL, /* get_base */
1055 NULL, /* get_bufsiz */
1058 NULL, /* set_ptrcnt */
1062 PerlIO_default_layers(pTHX)
1064 if (!PL_def_layerlist) {
1065 const char *s = (PL_tainting) ? Nullch : PerlEnv_getenv("PERLIO");
1066 PerlIO_funcs *osLayer = &PerlIO_unix;
1067 PL_def_layerlist = PerlIO_list_alloc(aTHX);
1068 PerlIO_define_layer(aTHX_ & PerlIO_unix);
1069 #if defined(WIN32) && !defined(UNDER_CE)
1070 PerlIO_define_layer(aTHX_ & PerlIO_win32);
1072 osLayer = &PerlIO_win32;
1075 PerlIO_define_layer(aTHX_ & PerlIO_raw);
1076 PerlIO_define_layer(aTHX_ & PerlIO_perlio);
1077 PerlIO_define_layer(aTHX_ & PerlIO_stdio);
1078 PerlIO_define_layer(aTHX_ & PerlIO_crlf);
1080 PerlIO_define_layer(aTHX_ & PerlIO_mmap);
1082 PerlIO_define_layer(aTHX_ & PerlIO_utf8);
1083 PerlIO_define_layer(aTHX_ & PerlIO_remove);
1084 PerlIO_define_layer(aTHX_ & PerlIO_byte);
1085 PerlIO_list_push(aTHX_ PL_def_layerlist,
1086 PerlIO_find_layer(aTHX_ osLayer->name, 0, 0),
1089 PerlIO_parse_layers(aTHX_ PL_def_layerlist, s);
1092 PerlIO_default_buffer(aTHX_ PL_def_layerlist);
1095 if (PL_def_layerlist->cur < 2) {
1096 PerlIO_default_buffer(aTHX_ PL_def_layerlist);
1098 return PL_def_layerlist;
1102 Perl_boot_core_PerlIO(pTHX)
1104 #ifdef USE_ATTRIBUTES_FOR_PERLIO
1105 newXS("io::MODIFY_SCALAR_ATTRIBUTES", XS_io_MODIFY_SCALAR_ATTRIBUTES,
1108 newXS("PerlIO::Layer::find", XS_PerlIO__Layer__find, __FILE__);
1109 newXS("PerlIO::Layer::NoWarnings", XS_PerlIO__Layer__NoWarnings, __FILE__);
1113 PerlIO_default_layer(pTHX_ I32 n)
1115 PerlIO_list_t *av = PerlIO_default_layers(aTHX);
1118 return PerlIO_layer_fetch(aTHX_ av, n, &PerlIO_stdio);
1121 #define PerlIO_default_top() PerlIO_default_layer(aTHX_ -1)
1122 #define PerlIO_default_btm() PerlIO_default_layer(aTHX_ 0)
1125 PerlIO_stdstreams(pTHX)
1128 PerlIO_allocate(aTHX);
1129 PerlIO_fdopen(0, "Ir" PERLIO_STDTEXT);
1130 PerlIO_fdopen(1, "Iw" PERLIO_STDTEXT);
1131 PerlIO_fdopen(2, "Iw" PERLIO_STDTEXT);
1136 PerlIO_push(pTHX_ PerlIO *f, PerlIO_funcs *tab, const char *mode, SV *arg)
1138 if (tab->fsize != sizeof(PerlIO_funcs)) {
1140 Perl_croak(aTHX_ "Layer does not match this perl");
1144 if (tab->size < sizeof(PerlIOl)) {
1147 /* Real layer with a data area */
1148 Newc('L',l,tab->size,char,PerlIOl);
1150 Zero(l, tab->size, char);
1154 PerlIO_debug("PerlIO_push f=%p %s %s %p\n", (void*)f, tab->name,
1155 (mode) ? mode : "(Null)", (void*)arg);
1156 if (*l->tab->Pushed &&
1157 (*l->tab->Pushed) (aTHX_ f, mode, arg, tab) != 0) {
1158 PerlIO_pop(aTHX_ f);
1164 /* Pseudo-layer where push does its own stack adjust */
1165 PerlIO_debug("PerlIO_push f=%p %s %s %p\n", (void*)f, tab->name,
1166 (mode) ? mode : "(Null)", (void*)arg);
1168 (*tab->Pushed) (aTHX_ f, mode, arg, tab) != 0) {
1176 PerlIOBase_binmode(pTHX_ PerlIO *f)
1178 if (PerlIOValid(f)) {
1179 /* Is layer suitable for raw stream ? */
1180 if (PerlIOBase(f)->tab->kind & PERLIO_K_RAW) {
1181 /* Yes - turn off UTF-8-ness, to undo UTF-8 locale effects */
1182 PerlIOBase(f)->flags &= ~PERLIO_F_UTF8;
1185 /* Not suitable - pop it */
1186 PerlIO_pop(aTHX_ f);
1194 PerlIORaw_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1197 if (PerlIOValid(f)) {
1202 * Strip all layers that are not suitable for a raw stream
1205 while (t && (l = *t)) {
1206 if (l->tab->Binmode) {
1207 /* Has a handler - normal case */
1208 if ((*l->tab->Binmode)(aTHX_ f) == 0) {
1210 /* Layer still there - move down a layer */
1219 /* No handler - pop it */
1220 PerlIO_pop(aTHX_ t);
1223 if (PerlIOValid(f)) {
1224 PerlIO_debug(":raw f=%p :%s\n", (void*)f, PerlIOBase(f)->tab->name);
1232 PerlIO_apply_layera(pTHX_ PerlIO *f, const char *mode,
1233 PerlIO_list_t *layers, IV n, IV max)
1237 PerlIO_funcs *tab = PerlIO_layer_fetch(aTHX_ layers, n, NULL);
1239 if (!PerlIO_push(aTHX_ f, tab, mode, PerlIOArg)) {
1250 PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode, const char *names)
1254 PerlIO_list_t *layers = PerlIO_list_alloc(aTHX);
1255 code = PerlIO_parse_layers(aTHX_ layers, names);
1257 code = PerlIO_apply_layera(aTHX_ f, mode, layers, 0, layers->cur);
1259 PerlIO_list_free(aTHX_ layers);
1265 /*--------------------------------------------------------------------------------------*/
1267 * Given the abstraction above the public API functions
1271 PerlIO_binmode(pTHX_ PerlIO *f, int iotype, int mode, const char *names)
1273 PerlIO_debug("PerlIO_binmode f=%p %s %c %x %s\n",
1274 (void*)f, PerlIOBase(f)->tab->name, iotype, mode,
1275 (names) ? names : "(Null)");
1277 /* Do not flush etc. if (e.g.) switching encodings.
1278 if a pushed layer knows it needs to flush lower layers
1279 (for example :unix which is never going to call them)
1280 it can do the flush when it is pushed.
1282 return PerlIO_apply_layers(aTHX_ f, NULL, names) == 0 ? TRUE : FALSE;
1285 /* Fake 5.6 legacy of using this call to turn ON O_TEXT */
1286 #ifdef PERLIO_USING_CRLF
1287 /* Legacy binmode only has meaning if O_TEXT has a value distinct from
1288 O_BINARY so we can look for it in mode.
1290 if (!(mode & O_BINARY)) {
1292 /* FIXME?: Looking down the layer stack seems wrong,
1293 but is a way of reaching past (say) an encoding layer
1294 to flip CRLF-ness of the layer(s) below
1297 /* Perhaps we should turn on bottom-most aware layer
1298 e.g. Ilya's idea that UNIX TTY could serve
1300 if (PerlIOBase(f)->tab->kind & PERLIO_K_CANCRLF) {
1301 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF)) {
1302 /* Not in text mode - flush any pending stuff and flip it */
1304 PerlIOBase(f)->flags |= PERLIO_F_CRLF;
1306 /* Only need to turn it on in one layer so we are done */
1311 /* Not finding a CRLF aware layer presumably means we are binary
1312 which is not what was requested - so we failed
1313 We _could_ push :crlf layer but so could caller
1318 /* Legacy binmode is now _defined_ as being equivalent to pushing :raw
1319 So code that used to be here is now in PerlIORaw_pushed().
1321 return PerlIO_push(aTHX_ f, &PerlIO_raw, Nullch, Nullsv) ? TRUE : FALSE;
1326 PerlIO__close(pTHX_ PerlIO *f)
1329 return (*PerlIOBase(f)->tab->Close) (aTHX_ f);
1331 SETERRNO(EBADF, SS_IVCHAN);
1337 Perl_PerlIO_close(pTHX_ PerlIO *f)
1341 if (PerlIOValid(f)) {
1342 PerlIO_funcs *tab = PerlIOBase(f)->tab;
1344 if (tab && tab->Close) {
1345 code = (*tab->Close)(aTHX_ f);
1347 PerlIO_pop(aTHX_ f);
1351 PerlIOBase_close(aTHX_ f);
1358 Perl_PerlIO_fileno(pTHX_ PerlIO *f)
1360 Perl_PerlIO_or_Base(f, Fileno, fileno, -1, (aTHX_ f));
1364 PerlIO_context_layers(pTHX_ const char *mode)
1366 const char *type = NULL;
1368 * Need to supply default layer info from open.pm
1371 SV *layers = PL_curcop->cop_io;
1374 type = SvPV(layers, len);
1375 if (type && mode[0] != 'r') {
1377 * Skip to write part
1379 const char *s = strchr(type, 0);
1380 if (s && (STRLEN)(s - type) < len) {
1389 static PerlIO_funcs *
1390 PerlIO_layer_from_ref(pTHX_ SV *sv)
1393 * For any scalar type load the handler which is bundled with perl
1395 if (SvTYPE(sv) < SVt_PVAV)
1396 return PerlIO_find_layer(aTHX_ "scalar", 6, 1);
1399 * For other types allow if layer is known but don't try and load it
1401 switch (SvTYPE(sv)) {
1403 return PerlIO_find_layer(aTHX_ "Array", 5, 0);
1405 return PerlIO_find_layer(aTHX_ "Hash", 4, 0);
1407 return PerlIO_find_layer(aTHX_ "Code", 4, 0);
1409 return PerlIO_find_layer(aTHX_ "Glob", 4, 0);
1415 PerlIO_resolve_layers(pTHX_ const char *layers,
1416 const char *mode, int narg, SV **args)
1418 PerlIO_list_t *def = PerlIO_default_layers(aTHX);
1421 PerlIO_stdstreams(aTHX);
1425 * If it is a reference but not an object see if we have a handler
1428 if (SvROK(arg) && !sv_isobject(arg)) {
1429 PerlIO_funcs *handler = PerlIO_layer_from_ref(aTHX_ SvRV(arg));
1431 def = PerlIO_list_alloc(aTHX);
1432 PerlIO_list_push(aTHX_ def, handler, &PL_sv_undef);
1436 * Don't fail if handler cannot be found :via(...) etc. may do
1437 * something sensible else we will just stringfy and open
1443 layers = PerlIO_context_layers(aTHX_ mode);
1444 if (layers && *layers) {
1448 av = PerlIO_list_alloc(aTHX);
1449 for (i = 0; i < def->cur; i++) {
1450 PerlIO_list_push(aTHX_ av, def->array[i].funcs,
1457 if (PerlIO_parse_layers(aTHX_ av, layers) == 0) {
1461 PerlIO_list_free(aTHX_ av);
1462 return (PerlIO_list_t *) NULL;
1473 PerlIO_openn(pTHX_ const char *layers, const char *mode, int fd,
1474 int imode, int perm, PerlIO *f, int narg, SV **args)
1476 if (!f && narg == 1 && *args == &PL_sv_undef) {
1477 if ((f = PerlIO_tmpfile())) {
1479 layers = PerlIO_context_layers(aTHX_ mode);
1480 if (layers && *layers)
1481 PerlIO_apply_layers(aTHX_ f, mode, layers);
1485 PerlIO_list_t *layera = NULL;
1487 PerlIO_funcs *tab = NULL;
1488 if (PerlIOValid(f)) {
1490 * This is "reopen" - it is not tested as perl does not use it
1494 layera = PerlIO_list_alloc(aTHX);
1496 SV *arg = (l->tab->Getarg)
1497 ? (*l->tab->Getarg) (aTHX_ &l, NULL, 0)
1499 PerlIO_list_push(aTHX_ layera, l->tab, arg);
1500 l = *PerlIONext(&l);
1504 layera = PerlIO_resolve_layers(aTHX_ layers, mode, narg, args);
1510 * Start at "top" of layer stack
1512 n = layera->cur - 1;
1514 PerlIO_funcs *t = PerlIO_layer_fetch(aTHX_ layera, n, NULL);
1523 * Found that layer 'n' can do opens - call it
1525 if (narg > 1 && !(tab->kind & PERLIO_K_MULTIARG)) {
1526 Perl_croak(aTHX_ "More than one argument to open(,':%s')",tab->name);
1528 PerlIO_debug("openn(%s,'%s','%s',%d,%x,%o,%p,%d,%p)\n",
1529 tab->name, layers, mode, fd, imode, perm,
1530 (void*)f, narg, (void*)args);
1532 f = (*tab->Open) (aTHX_ tab, layera, n, mode, fd, imode, perm,
1535 SETERRNO(EINVAL, LIB_INVARG);
1539 if (n + 1 < layera->cur) {
1541 * More layers above the one that we used to open -
1544 if (PerlIO_apply_layera(aTHX_ f, mode, layera, n + 1, layera->cur) != 0) {
1545 /* If pushing layers fails close the file */
1552 PerlIO_list_free(aTHX_ layera);
1559 Perl_PerlIO_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
1561 Perl_PerlIO_or_Base(f, Read, read, -1, (aTHX_ f, vbuf, count));
1565 Perl_PerlIO_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
1567 Perl_PerlIO_or_Base(f, Unread, unread, -1, (aTHX_ f, vbuf, count));
1571 Perl_PerlIO_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
1573 Perl_PerlIO_or_fail(f, Write, -1, (aTHX_ f, vbuf, count));
1577 Perl_PerlIO_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
1579 Perl_PerlIO_or_fail(f, Seek, -1, (aTHX_ f, offset, whence));
1583 Perl_PerlIO_tell(pTHX_ PerlIO *f)
1585 Perl_PerlIO_or_fail(f, Tell, -1, (aTHX_ f));
1589 Perl_PerlIO_flush(pTHX_ PerlIO *f)
1593 PerlIO_funcs *tab = PerlIOBase(f)->tab;
1595 if (tab && tab->Flush)
1596 return (*tab->Flush) (aTHX_ f);
1598 return 0; /* If no Flush defined, silently succeed. */
1601 PerlIO_debug("Cannot flush f=%p\n", (void*)f);
1602 SETERRNO(EBADF, SS_IVCHAN);
1608 * Is it good API design to do flush-all on NULL, a potentially
1609 * errorneous input? Maybe some magical value (PerlIO*
1610 * PERLIO_FLUSH_ALL = (PerlIO*)-1;)? Yes, stdio does similar
1611 * things on fflush(NULL), but should we be bound by their design
1614 PerlIO **table = &PL_perlio;
1616 while ((f = *table)) {
1618 table = (PerlIO **) (f++);
1619 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
1620 if (*f && PerlIO_flush(f) != 0)
1630 PerlIOBase_flush_linebuf(pTHX)
1632 PerlIO **table = &PL_perlio;
1634 while ((f = *table)) {
1636 table = (PerlIO **) (f++);
1637 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
1640 flags & (PERLIO_F_LINEBUF | PERLIO_F_CANWRITE))
1641 == (PERLIO_F_LINEBUF | PERLIO_F_CANWRITE))
1649 Perl_PerlIO_fill(pTHX_ PerlIO *f)
1651 Perl_PerlIO_or_fail(f, Fill, -1, (aTHX_ f));
1655 PerlIO_isutf8(PerlIO *f)
1658 return (PerlIOBase(f)->flags & PERLIO_F_UTF8) != 0;
1660 SETERRNO(EBADF, SS_IVCHAN);
1666 Perl_PerlIO_eof(pTHX_ PerlIO *f)
1668 Perl_PerlIO_or_Base(f, Eof, eof, -1, (aTHX_ f));
1672 Perl_PerlIO_error(pTHX_ PerlIO *f)
1674 Perl_PerlIO_or_Base(f, Error, error, -1, (aTHX_ f));
1678 Perl_PerlIO_clearerr(pTHX_ PerlIO *f)
1680 Perl_PerlIO_or_Base_void(f, Clearerr, clearerr, (aTHX_ f));
1684 Perl_PerlIO_setlinebuf(pTHX_ PerlIO *f)
1686 Perl_PerlIO_or_Base_void(f, Setlinebuf, setlinebuf, (aTHX_ f));
1690 PerlIO_has_base(PerlIO *f)
1692 if (PerlIOValid(f)) {
1693 PerlIO_funcs *tab = PerlIOBase(f)->tab;
1696 return (tab->Get_base != NULL);
1697 SETERRNO(EINVAL, LIB_INVARG);
1700 SETERRNO(EBADF, SS_IVCHAN);
1706 PerlIO_fast_gets(PerlIO *f)
1708 if (PerlIOValid(f) && (PerlIOBase(f)->flags & PERLIO_F_FASTGETS)) {
1709 PerlIO_funcs *tab = PerlIOBase(f)->tab;
1712 return (tab->Set_ptrcnt != NULL);
1713 SETERRNO(EINVAL, LIB_INVARG);
1716 SETERRNO(EBADF, SS_IVCHAN);
1722 PerlIO_has_cntptr(PerlIO *f)
1724 if (PerlIOValid(f)) {
1725 PerlIO_funcs *tab = PerlIOBase(f)->tab;
1728 return (tab->Get_ptr != NULL && tab->Get_cnt != NULL);
1729 SETERRNO(EINVAL, LIB_INVARG);
1732 SETERRNO(EBADF, SS_IVCHAN);
1738 PerlIO_canset_cnt(PerlIO *f)
1740 if (PerlIOValid(f)) {
1741 PerlIO_funcs *tab = PerlIOBase(f)->tab;
1744 return (tab->Set_ptrcnt != NULL);
1745 SETERRNO(EINVAL, LIB_INVARG);
1748 SETERRNO(EBADF, SS_IVCHAN);
1754 Perl_PerlIO_get_base(pTHX_ PerlIO *f)
1756 Perl_PerlIO_or_fail(f, Get_base, NULL, (aTHX_ f));
1760 Perl_PerlIO_get_bufsiz(pTHX_ PerlIO *f)
1762 Perl_PerlIO_or_fail(f, Get_bufsiz, -1, (aTHX_ f));
1766 Perl_PerlIO_get_ptr(pTHX_ PerlIO *f)
1768 Perl_PerlIO_or_fail(f, Get_ptr, NULL, (aTHX_ f));
1772 Perl_PerlIO_get_cnt(pTHX_ PerlIO *f)
1774 Perl_PerlIO_or_fail(f, Get_cnt, -1, (aTHX_ f));
1778 Perl_PerlIO_set_cnt(pTHX_ PerlIO *f, int cnt)
1780 Perl_PerlIO_or_fail_void(f, Set_ptrcnt, (aTHX_ f, NULL, cnt));
1784 Perl_PerlIO_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, int cnt)
1786 Perl_PerlIO_or_fail_void(f, Set_ptrcnt, (aTHX_ f, ptr, cnt));
1790 /*--------------------------------------------------------------------------------------*/
1792 * utf8 and raw dummy layers
1796 PerlIOUtf8_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1798 if (PerlIOValid(f)) {
1799 if (tab->kind & PERLIO_K_UTF8)
1800 PerlIOBase(f)->flags |= PERLIO_F_UTF8;
1802 PerlIOBase(f)->flags &= ~PERLIO_F_UTF8;
1808 PerlIO_funcs PerlIO_utf8 = {
1809 sizeof(PerlIO_funcs),
1812 PERLIO_K_DUMMY | PERLIO_K_UTF8,
1830 NULL, /* get_base */
1831 NULL, /* get_bufsiz */
1834 NULL, /* set_ptrcnt */
1837 PerlIO_funcs PerlIO_byte = {
1838 sizeof(PerlIO_funcs),
1859 NULL, /* get_base */
1860 NULL, /* get_bufsiz */
1863 NULL, /* set_ptrcnt */
1867 PerlIORaw_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
1868 IV n, const char *mode, int fd, int imode, int perm,
1869 PerlIO *old, int narg, SV **args)
1871 PerlIO_funcs *tab = PerlIO_default_btm();
1872 if (tab && tab->Open)
1873 return (*tab->Open) (aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
1875 SETERRNO(EINVAL, LIB_INVARG);
1879 PerlIO_funcs PerlIO_raw = {
1880 sizeof(PerlIO_funcs),
1901 NULL, /* get_base */
1902 NULL, /* get_bufsiz */
1905 NULL, /* set_ptrcnt */
1907 /*--------------------------------------------------------------------------------------*/
1908 /*--------------------------------------------------------------------------------------*/
1910 * "Methods" of the "base class"
1914 PerlIOBase_fileno(pTHX_ PerlIO *f)
1916 return PerlIOValid(f) ? PerlIO_fileno(PerlIONext(f)) : -1;
1920 PerlIO_modestr(PerlIO * f, char *buf)
1923 if (PerlIOValid(f)) {
1924 IV flags = PerlIOBase(f)->flags;
1925 if (flags & PERLIO_F_APPEND) {
1927 if (flags & PERLIO_F_CANREAD) {
1931 else if (flags & PERLIO_F_CANREAD) {
1933 if (flags & PERLIO_F_CANWRITE)
1936 else if (flags & PERLIO_F_CANWRITE) {
1938 if (flags & PERLIO_F_CANREAD) {
1942 #ifdef PERLIO_USING_CRLF
1943 if (!(flags & PERLIO_F_CRLF))
1953 PerlIOBase_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1955 PerlIOl *l = PerlIOBase(f);
1957 const char *omode = mode;
1960 l->flags &= ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE |
1961 PERLIO_F_TRUNCATE | PERLIO_F_APPEND);
1962 if (tab->Set_ptrcnt != NULL)
1963 l->flags |= PERLIO_F_FASTGETS;
1965 if (*mode == '#' || *mode == 'I')
1969 l->flags |= PERLIO_F_CANREAD;
1972 l->flags |= PERLIO_F_APPEND | PERLIO_F_CANWRITE;
1975 l->flags |= PERLIO_F_TRUNCATE | PERLIO_F_CANWRITE;
1978 SETERRNO(EINVAL, LIB_INVARG);
1984 l->flags |= PERLIO_F_CANREAD | PERLIO_F_CANWRITE;
1987 l->flags &= ~PERLIO_F_CRLF;
1990 l->flags |= PERLIO_F_CRLF;
1993 SETERRNO(EINVAL, LIB_INVARG);
2000 l->flags |= l->next->flags &
2001 (PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_TRUNCATE |
2006 PerlIO_debug("PerlIOBase_pushed f=%p %s %s fl=%08" UVxf " (%s)\n",
2007 f, PerlIOBase(f)->tab->name, (omode) ? omode : "(Null)",
2008 l->flags, PerlIO_modestr(f, temp));
2014 PerlIOBase_popped(pTHX_ PerlIO *f)
2020 PerlIOBase_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
2023 * Save the position as current head considers it
2025 Off_t old = PerlIO_tell(f);
2027 PerlIO_push(aTHX_ f, &PerlIO_pending, "r", Nullsv);
2028 PerlIOSelf(f, PerlIOBuf)->posn = old;
2029 done = PerlIOBuf_unread(aTHX_ f, vbuf, count);
2034 PerlIOBase_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
2036 STDCHAR *buf = (STDCHAR *) vbuf;
2038 if (!(PerlIOBase(f)->flags & PERLIO_F_CANREAD))
2041 SSize_t avail = PerlIO_get_cnt(f);
2044 take = ((SSize_t)count < avail) ? count : avail;
2046 STDCHAR *ptr = PerlIO_get_ptr(f);
2047 Copy(ptr, buf, take, STDCHAR);
2048 PerlIO_set_ptrcnt(f, ptr + take, (avail -= take));
2052 if (count > 0 && avail <= 0) {
2053 if (PerlIO_fill(f) != 0)
2057 return (buf - (STDCHAR *) vbuf);
2063 PerlIOBase_noop_ok(pTHX_ PerlIO *f)
2069 PerlIOBase_noop_fail(pTHX_ PerlIO *f)
2075 PerlIOBase_close(pTHX_ PerlIO *f)
2078 PerlIO *n = PerlIONext(f);
2079 if (PerlIO_flush(f) != 0)
2081 if (PerlIOValid(n) && (*PerlIOBase(n)->tab->Close)(aTHX_ n) != 0)
2083 PerlIOBase(f)->flags &=
2084 ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_OPEN);
2089 PerlIOBase_eof(pTHX_ PerlIO *f)
2091 if (PerlIOValid(f)) {
2092 return (PerlIOBase(f)->flags & PERLIO_F_EOF) != 0;
2098 PerlIOBase_error(pTHX_ PerlIO *f)
2100 if (PerlIOValid(f)) {
2101 return (PerlIOBase(f)->flags & PERLIO_F_ERROR) != 0;
2107 PerlIOBase_clearerr(pTHX_ PerlIO *f)
2109 if (PerlIOValid(f)) {
2110 PerlIO *n = PerlIONext(f);
2111 PerlIOBase(f)->flags &= ~(PERLIO_F_ERROR | PERLIO_F_EOF);
2118 PerlIOBase_setlinebuf(pTHX_ PerlIO *f)
2120 if (PerlIOValid(f)) {
2121 PerlIOBase(f)->flags |= PERLIO_F_LINEBUF;
2126 PerlIO_sv_dup(pTHX_ SV *arg, CLONE_PARAMS *param)
2132 return sv_dup(arg, param);
2135 return newSVsv(arg);
2138 return newSVsv(arg);
2143 PerlIOBase_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2145 PerlIO *nexto = PerlIONext(o);
2146 if (PerlIOValid(nexto)) {
2147 PerlIO_funcs *tab = PerlIOBase(nexto)->tab;
2148 f = (*tab->Dup)(aTHX_ f, nexto, param, flags);
2151 PerlIO_funcs *self = PerlIOBase(o)->tab;
2154 PerlIO_debug("PerlIOBase_dup %s f=%p o=%p param=%p\n",
2155 self->name, (void*)f, (void*)o, (void*)param);
2157 arg = (*self->Getarg)(aTHX_ o, param, flags);
2160 SETERRNO(EINVAL, LIB_INVARG);
2162 f = PerlIO_push(aTHX_ f, self, PerlIO_modestr(o,buf), arg);
2170 #define PERLIO_MAX_REFCOUNTABLE_FD 2048
2172 perl_mutex PerlIO_mutex;
2174 int PerlIO_fd_refcnt[PERLIO_MAX_REFCOUNTABLE_FD];
2179 /* Place holder for stdstreams call ??? */
2181 MUTEX_INIT(&PerlIO_mutex);
2186 PerlIOUnix_refcnt_inc(int fd)
2188 if (fd >= 0 && fd < PERLIO_MAX_REFCOUNTABLE_FD) {
2190 MUTEX_LOCK(&PerlIO_mutex);
2192 PerlIO_fd_refcnt[fd]++;
2193 PerlIO_debug("fd %d refcnt=%d\n",fd,PerlIO_fd_refcnt[fd]);
2195 MUTEX_UNLOCK(&PerlIO_mutex);
2201 PerlIOUnix_refcnt_dec(int fd)
2204 if (fd >= 0 && fd < PERLIO_MAX_REFCOUNTABLE_FD) {
2206 MUTEX_LOCK(&PerlIO_mutex);
2208 cnt = --PerlIO_fd_refcnt[fd];
2209 PerlIO_debug("fd %d refcnt=%d\n",fd,cnt);
2211 MUTEX_UNLOCK(&PerlIO_mutex);
2218 PerlIO_cleanup(pTHX)
2222 PerlIO_debug("Cleanup layers for %p\n",aTHX);
2224 PerlIO_debug("Cleanup layers\n");
2226 /* Raise STDIN..STDERR refcount so we don't close them */
2227 for (i=0; i < 3; i++)
2228 PerlIOUnix_refcnt_inc(i);
2229 PerlIO_cleantable(aTHX_ &PL_perlio);
2230 /* Restore STDIN..STDERR refcount */
2231 for (i=0; i < 3; i++)
2232 PerlIOUnix_refcnt_dec(i);
2234 if (PL_known_layers) {
2235 PerlIO_list_free(aTHX_ PL_known_layers);
2236 PL_known_layers = NULL;
2238 if(PL_def_layerlist) {
2239 PerlIO_list_free(aTHX_ PL_def_layerlist);
2240 PL_def_layerlist = NULL;
2246 /*--------------------------------------------------------------------------------------*/
2248 * Bottom-most level for UNIX-like case
2252 struct _PerlIO base; /* The generic part */
2253 int fd; /* UNIX like file descriptor */
2254 int oflags; /* open/fcntl flags */
2258 PerlIOUnix_oflags(const char *mode)
2261 if (*mode == 'I' || *mode == '#')
2266 if (*++mode == '+') {
2273 oflags = O_CREAT | O_TRUNC;
2274 if (*++mode == '+') {
2283 oflags = O_CREAT | O_APPEND;
2284 if (*++mode == '+') {
2297 else if (*mode == 't') {
2299 oflags &= ~O_BINARY;
2303 * Always open in binary mode
2306 if (*mode || oflags == -1) {
2307 SETERRNO(EINVAL, LIB_INVARG);
2314 PerlIOUnix_fileno(pTHX_ PerlIO *f)
2316 return PerlIOSelf(f, PerlIOUnix)->fd;
2320 PerlIOUnix_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2322 IV code = PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
2323 PerlIOUnix *s = PerlIOSelf(f, PerlIOUnix);
2324 if (*PerlIONext(f)) {
2325 /* We never call down so do any pending stuff now */
2326 PerlIO_flush(PerlIONext(f));
2327 s->fd = PerlIO_fileno(PerlIONext(f));
2329 * XXX could (or should) we retrieve the oflags from the open file
2330 * handle rather than believing the "mode" we are passed in? XXX
2331 * Should the value on NULL mode be 0 or -1?
2333 s->oflags = mode ? PerlIOUnix_oflags(mode) : -1;
2335 PerlIOBase(f)->flags |= PERLIO_F_OPEN;
2340 PerlIOUnix_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
2341 IV n, const char *mode, int fd, int imode,
2342 int perm, PerlIO *f, int narg, SV **args)
2344 if (PerlIOValid(f)) {
2345 if (PerlIOBase(f)->flags & PERLIO_F_OPEN)
2346 (*PerlIOBase(f)->tab->Close)(aTHX_ f);
2349 char *path = SvPV_nolen(*args);
2353 imode = PerlIOUnix_oflags(mode);
2357 fd = PerlLIO_open3(path, imode, perm);
2365 f = PerlIO_allocate(aTHX);
2367 if (!PerlIOValid(f)) {
2368 if (!(f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg))) {
2372 s = PerlIOSelf(f, PerlIOUnix);
2375 PerlIOBase(f)->flags |= PERLIO_F_OPEN;
2376 PerlIOUnix_refcnt_inc(fd);
2382 * FIXME: pop layers ???
2390 PerlIOUnix_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2392 PerlIOUnix *os = PerlIOSelf(o, PerlIOUnix);
2394 if (flags & PERLIO_DUP_FD) {
2395 fd = PerlLIO_dup(fd);
2397 if (fd >= 0 && fd < PERLIO_MAX_REFCOUNTABLE_FD) {
2398 f = PerlIOBase_dup(aTHX_ f, o, param, flags);
2400 /* If all went well overwrite fd in dup'ed lay with the dup()'ed fd */
2401 PerlIOUnix *s = PerlIOSelf(f, PerlIOUnix);
2403 PerlIOUnix_refcnt_inc(fd);
2412 PerlIOUnix_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
2414 int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2415 if (!(PerlIOBase(f)->flags & PERLIO_F_CANREAD) ||
2416 PerlIOBase(f)->flags & (PERLIO_F_EOF|PERLIO_F_ERROR)) {
2420 SSize_t len = PerlLIO_read(fd, vbuf, count);
2421 if (len >= 0 || errno != EINTR) {
2423 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2424 else if (len == 0 && count != 0)
2425 PerlIOBase(f)->flags |= PERLIO_F_EOF;
2433 PerlIOUnix_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
2435 int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2437 SSize_t len = PerlLIO_write(fd, vbuf, count);
2438 if (len >= 0 || errno != EINTR) {
2440 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2448 PerlIOUnix_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
2451 PerlLIO_lseek(PerlIOSelf(f, PerlIOUnix)->fd, offset, whence);
2452 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
2453 return (new == (Off_t) - 1) ? -1 : 0;
2457 PerlIOUnix_tell(pTHX_ PerlIO *f)
2459 return PerlLIO_lseek(PerlIOSelf(f, PerlIOUnix)->fd, 0, SEEK_CUR);
2464 PerlIOUnix_close(pTHX_ PerlIO *f)
2466 int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2468 if (PerlIOBase(f)->flags & PERLIO_F_OPEN) {
2469 if (PerlIOUnix_refcnt_dec(fd) > 0) {
2470 PerlIOBase(f)->flags &= ~PERLIO_F_OPEN;
2475 SETERRNO(EBADF,SS_IVCHAN);
2478 while (PerlLIO_close(fd) != 0) {
2479 if (errno != EINTR) {
2486 PerlIOBase(f)->flags &= ~PERLIO_F_OPEN;
2491 PerlIO_funcs PerlIO_unix = {
2492 sizeof(PerlIO_funcs),
2499 PerlIOBase_binmode, /* binmode */
2509 PerlIOBase_noop_ok, /* flush */
2510 PerlIOBase_noop_fail, /* fill */
2513 PerlIOBase_clearerr,
2514 PerlIOBase_setlinebuf,
2515 NULL, /* get_base */
2516 NULL, /* get_bufsiz */
2519 NULL, /* set_ptrcnt */
2522 /*--------------------------------------------------------------------------------------*/
2527 #if defined(VMS) && !defined(STDIO_BUFFER_WRITABLE)
2528 /* perl5.8 - This ensures the last minute VMS ungetc fix is not
2529 broken by the last second glibc 2.3 fix
2531 #define STDIO_BUFFER_WRITABLE
2536 struct _PerlIO base;
2537 FILE *stdio; /* The stream */
2541 PerlIOStdio_fileno(pTHX_ PerlIO *f)
2544 if (PerlIOValid(f) && (s = PerlIOSelf(f, PerlIOStdio)->stdio)) {
2545 return PerlSIO_fileno(s);
2552 PerlIOStdio_mode(const char *mode, char *tmode)
2558 #ifdef PERLIO_USING_CRLF
2566 PerlIOStdio_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2569 if (PerlIOValid(f) && PerlIOValid(n = PerlIONext(f))) {
2570 PerlIO_funcs *toptab = PerlIOBase(n)->tab;
2571 if (toptab == tab) {
2572 /* Top is already stdio - pop self (duplicate) and use original */
2573 PerlIO_pop(aTHX_ f);
2576 int fd = PerlIO_fileno(n);
2579 if (fd >= 0 && (stdio = PerlSIO_fdopen(fd,
2580 mode = PerlIOStdio_mode(mode, tmode)))) {
2581 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2582 /* We never call down so do any pending stuff now */
2583 PerlIO_flush(PerlIONext(f));
2590 return PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
2595 PerlIO_importFILE(FILE *stdio, const char *mode)
2601 if (!mode || !*mode) {
2602 /* We need to probe to see how we can open the stream
2603 so start with read/write and then try write and read
2604 we dup() so that we can fclose without loosing the fd.
2606 Note that the errno value set by a failing fdopen
2607 varies between stdio implementations.
2609 int fd = PerlLIO_dup(fileno(stdio));
2610 FILE *f2 = PerlSIO_fdopen(fd, (mode = "r+"));
2612 f2 = PerlSIO_fdopen(fd, (mode = "w"));
2615 f2 = PerlSIO_fdopen(fd, (mode = "r"));
2618 /* Don't seem to be able to open */
2624 if ((f = PerlIO_push(aTHX_(f = PerlIO_allocate(aTHX)), &PerlIO_stdio, mode, Nullsv))) {
2625 s = PerlIOSelf(f, PerlIOStdio);
2633 PerlIOStdio_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
2634 IV n, const char *mode, int fd, int imode,
2635 int perm, PerlIO *f, int narg, SV **args)
2638 if (PerlIOValid(f)) {
2639 char *path = SvPV_nolen(*args);
2640 PerlIOStdio *s = PerlIOSelf(f, PerlIOStdio);
2642 PerlIOUnix_refcnt_dec(fileno(s->stdio));
2643 stdio = PerlSIO_freopen(path, (mode = PerlIOStdio_mode(mode, tmode)),
2648 PerlIOUnix_refcnt_inc(fileno(s->stdio));
2653 char *path = SvPV_nolen(*args);
2656 fd = PerlLIO_open3(path, imode, perm);
2659 FILE *stdio = PerlSIO_fopen(path, mode);
2663 f = PerlIO_allocate(aTHX);
2665 if ((f = PerlIO_push(aTHX_ f, self,
2666 (mode = PerlIOStdio_mode(mode, tmode)),
2668 s = PerlIOSelf(f, PerlIOStdio);
2670 PerlIOUnix_refcnt_inc(fileno(s->stdio));
2689 stdio = PerlSIO_stdin;
2692 stdio = PerlSIO_stdout;
2695 stdio = PerlSIO_stderr;
2700 stdio = PerlSIO_fdopen(fd, mode =
2701 PerlIOStdio_mode(mode, tmode));
2706 f = PerlIO_allocate(aTHX);
2708 if ((f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg))) {
2709 s = PerlIOSelf(f, PerlIOStdio);
2711 PerlIOUnix_refcnt_inc(fileno(s->stdio));
2721 PerlIOStdio_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2723 /* This assumes no layers underneath - which is what
2724 happens, but is not how I remember it. NI-S 2001/10/16
2726 if ((f = PerlIOBase_dup(aTHX_ f, o, param, flags))) {
2727 FILE *stdio = PerlIOSelf(o, PerlIOStdio)->stdio;
2728 int fd = fileno(stdio);
2730 if (flags & PERLIO_DUP_FD) {
2731 int dfd = PerlLIO_dup(fileno(stdio));
2733 stdio = PerlSIO_fdopen(dfd, PerlIO_modestr(o,mode));
2737 /* FIXME: To avoid messy error recovery if dup fails
2738 re-use the existing stdio as though flag was not set
2742 stdio = PerlSIO_fdopen(fd, PerlIO_modestr(o,mode));
2744 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2745 PerlIOUnix_refcnt_inc(fileno(stdio));
2751 PerlIOStdio_invalidate_fileno(pTHX_ FILE *f)
2753 /* XXX this could use PerlIO_canset_fileno() and
2754 * PerlIO_set_fileno() support from Configure
2756 # if defined(__GLIBC__)
2757 /* There may be a better way for GLIBC:
2758 - libio.h defines a flag to not close() on cleanup
2762 # elif defined(__sun__)
2764 /* On solaris, if _LP64 is defined, the FILE structure is this:
2770 * It turns out that the fd is stored in the top 32 bits of
2771 * file->__pad[4]. The lower 32 bits contain flags. file->pad[5] appears
2772 * to contain a pointer or offset into another structure. All the
2773 * remaining fields are zero.
2775 * We set the top bits to -1 (0xFFFFFFFF).
2777 f->__pad[4] |= 0xffffffff00000000L;
2778 assert(fileno(f) == 0xffffffff);
2779 # else /* !defined(_LP64) */
2780 /* _file is just a unsigned char :-(
2781 Not clear why we dup() rather than using -1
2782 even if that would be treated as 0xFF - so will
2785 f->_file = PerlLIO_dup(fileno(f));
2786 # endif /* defined(_LP64) */
2788 # elif defined(__hpux)
2792 /* Next one ->_file seems to be a reasonable fallback, i.e. if
2793 your platform does not have special entry try this one.
2794 [For OSF only have confirmation for Tru64 (alpha)
2795 but assume other OSFs will be similar.]
2797 # elif defined(_AIX) || defined(__osf__) || defined(__irix__)
2800 # elif defined(__FreeBSD__)
2801 /* There may be a better way on FreeBSD:
2802 - we could insert a dummy func in the _close function entry
2803 f->_close = (int (*)(void *)) dummy_close;
2807 # elif defined(__CYGWIN__)
2808 /* There may be a better way on CYGWIN:
2809 - we could insert a dummy func in the _close function entry
2810 f->_close = (int (*)(void *)) dummy_close;
2814 # elif defined(WIN32)
2815 # if defined(__BORLANDC__)
2816 f->fd = PerlLIO_dup(fileno(f));
2817 # elif defined(UNDER_CE)
2818 /* WIN_CE does not have access to FILE internals, it hardly has FILE
2827 /* Sarathy's code did this - we fall back to a dup/dup2 hack
2828 (which isn't thread safe) instead
2830 # error "Don't know how to set FILE.fileno on your platform"
2837 PerlIOStdio_close(pTHX_ PerlIO *f)
2839 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
2845 int fd = fileno(stdio);
2851 #ifdef SOCKS5_VERSION_NAME
2852 /* Socks lib overrides close() but stdio isn't linked to
2853 that library (though we are) - so we must call close()
2854 on sockets on stdio's behalf.
2857 Sock_size_t optlen = sizeof(int);
2858 if (getsockopt(fd, SOL_SOCKET, SO_TYPE, (void *) &optval, &optlen) == 0) {
2863 if (PerlIOUnix_refcnt_dec(fd) > 0) {
2864 /* File descriptor still in use */
2869 /* For STD* handles don't close the stdio at all
2870 this is because we have shared the FILE * too
2872 if (stdio == stdin) {
2873 /* Some stdios are buggy fflush-ing inputs */
2876 else if (stdio == stdout || stdio == stderr) {
2877 return PerlIO_flush(f);
2879 /* Tricky - must fclose(stdio) to free memory but not close(fd)
2880 Use Sarathy's trick from maint-5.6 to invalidate the
2881 fileno slot of the FILE *
2883 result = PerlIO_flush(f);
2885 if (!(invalidate = PerlIOStdio_invalidate_fileno(aTHX_ stdio))) {
2886 dupfd = PerlLIO_dup(fd);
2889 result = PerlSIO_fclose(stdio);
2890 /* We treat error from stdio as success if we invalidated
2891 errno may NOT be expected EBADF
2893 if (invalidate && result != 0) {
2898 /* in SOCKS case let close() determine return value */
2902 PerlLIO_dup2(dupfd,fd);
2910 PerlIOStdio_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
2912 FILE *s = PerlIOSelf(f, PerlIOStdio)->stdio;
2916 STDCHAR *buf = (STDCHAR *) vbuf;
2918 * Perl is expecting PerlIO_getc() to fill the buffer Linux's
2919 * stdio does not do that for fread()
2921 int ch = PerlSIO_fgetc(s);
2928 got = PerlSIO_fread(vbuf, 1, count, s);
2929 if (got || errno != EINTR)
2932 errno = 0; /* just in case */
2938 PerlIOStdio_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
2941 FILE *s = PerlIOSelf(f, PerlIOStdio)->stdio;
2943 #ifdef STDIO_BUFFER_WRITABLE
2944 if (PerlIO_fast_gets(f) && PerlIO_has_base(f)) {
2945 STDCHAR *buf = ((STDCHAR *) vbuf) + count;
2946 STDCHAR *base = PerlIO_get_base(f);
2947 SSize_t cnt = PerlIO_get_cnt(f);
2948 STDCHAR *ptr = PerlIO_get_ptr(f);
2949 SSize_t avail = ptr - base;
2951 if (avail > count) {
2955 Move(buf-avail,ptr,avail,STDCHAR);
2958 PerlIO_set_ptrcnt(f,ptr,cnt+avail);
2959 if (PerlSIO_feof(s) && unread >= 0)
2960 PerlSIO_clearerr(s);
2965 if (PerlIO_has_cntptr(f)) {
2966 /* We can get pointer to buffer but not its base
2967 Do ungetc() but check chars are ending up in the
2970 STDCHAR *eptr = (STDCHAR*)PerlSIO_get_ptr(s);
2971 STDCHAR *buf = ((STDCHAR *) vbuf) + count;
2973 int ch = *--buf & 0xFF;
2974 if (ungetc(ch,s) != ch) {
2975 /* ungetc did not work */
2978 if ((STDCHAR*)PerlSIO_get_ptr(s) != --eptr || ((*eptr & 0xFF) != ch)) {
2979 /* Did not change pointer as expected */
2980 fgetc(s); /* get char back again */
2990 unread += PerlIOBase_unread(aTHX_ f, vbuf, count);
2996 PerlIOStdio_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3000 got = PerlSIO_fwrite(vbuf, 1, count,
3001 PerlIOSelf(f, PerlIOStdio)->stdio);
3002 if (got || errno != EINTR)
3005 errno = 0; /* just in case */
3011 PerlIOStdio_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3013 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3014 return PerlSIO_fseek(stdio, offset, whence);
3018 PerlIOStdio_tell(pTHX_ PerlIO *f)
3020 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3021 return PerlSIO_ftell(stdio);
3025 PerlIOStdio_flush(pTHX_ PerlIO *f)
3027 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3028 if (PerlIOBase(f)->flags & PERLIO_F_CANWRITE) {
3029 return PerlSIO_fflush(stdio);
3034 * FIXME: This discards ungetc() and pre-read stuff which is not
3035 * right if this is just a "sync" from a layer above Suspect right
3036 * design is to do _this_ but not have layer above flush this
3037 * layer read-to-read
3040 * Not writeable - sync by attempting a seek
3043 if (PerlSIO_fseek(stdio, (Off_t) 0, SEEK_CUR) != 0)
3051 PerlIOStdio_eof(pTHX_ PerlIO *f)
3053 return PerlSIO_feof(PerlIOSelf(f, PerlIOStdio)->stdio);
3057 PerlIOStdio_error(pTHX_ PerlIO *f)
3059 return PerlSIO_ferror(PerlIOSelf(f, PerlIOStdio)->stdio);
3063 PerlIOStdio_clearerr(pTHX_ PerlIO *f)
3065 PerlSIO_clearerr(PerlIOSelf(f, PerlIOStdio)->stdio);
3069 PerlIOStdio_setlinebuf(pTHX_ PerlIO *f)
3071 #ifdef HAS_SETLINEBUF
3072 PerlSIO_setlinebuf(PerlIOSelf(f, PerlIOStdio)->stdio);
3074 PerlSIO_setvbuf(PerlIOSelf(f, PerlIOStdio)->stdio, Nullch, _IOLBF, 0);
3080 PerlIOStdio_get_base(pTHX_ PerlIO *f)
3082 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3083 return (STDCHAR*)PerlSIO_get_base(stdio);
3087 PerlIOStdio_get_bufsiz(pTHX_ PerlIO *f)
3089 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3090 return PerlSIO_get_bufsiz(stdio);
3094 #ifdef USE_STDIO_PTR
3096 PerlIOStdio_get_ptr(pTHX_ PerlIO *f)
3098 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3099 return (STDCHAR*)PerlSIO_get_ptr(stdio);
3103 PerlIOStdio_get_cnt(pTHX_ PerlIO *f)
3105 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3106 return PerlSIO_get_cnt(stdio);
3110 PerlIOStdio_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
3112 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3114 #ifdef STDIO_PTR_LVALUE
3115 PerlSIO_set_ptr(stdio, (void*)ptr); /* LHS STDCHAR* cast non-portable */
3116 #ifdef STDIO_PTR_LVAL_SETS_CNT
3117 if (PerlSIO_get_cnt(stdio) != (cnt)) {
3118 assert(PerlSIO_get_cnt(stdio) == (cnt));
3121 #if (!defined(STDIO_PTR_LVAL_NOCHANGE_CNT))
3123 * Setting ptr _does_ change cnt - we are done
3127 #else /* STDIO_PTR_LVALUE */
3129 #endif /* STDIO_PTR_LVALUE */
3132 * Now (or only) set cnt
3134 #ifdef STDIO_CNT_LVALUE
3135 PerlSIO_set_cnt(stdio, cnt);
3136 #else /* STDIO_CNT_LVALUE */
3137 #if (defined(STDIO_PTR_LVALUE) && defined(STDIO_PTR_LVAL_SETS_CNT))
3138 PerlSIO_set_ptr(stdio,
3139 PerlSIO_get_ptr(stdio) + (PerlSIO_get_cnt(stdio) -
3141 #else /* STDIO_PTR_LVAL_SETS_CNT */
3143 #endif /* STDIO_PTR_LVAL_SETS_CNT */
3144 #endif /* STDIO_CNT_LVALUE */
3151 PerlIOStdio_fill(pTHX_ PerlIO *f)
3153 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3156 * fflush()ing read-only streams can cause trouble on some stdio-s
3158 if ((PerlIOBase(f)->flags & PERLIO_F_CANWRITE)) {
3159 if (PerlSIO_fflush(stdio) != 0)
3162 c = PerlSIO_fgetc(stdio);
3166 #if (defined(STDIO_PTR_LVALUE) && (defined(STDIO_CNT_LVALUE) || defined(STDIO_PTR_LVAL_SETS_CNT)))
3168 #ifdef STDIO_BUFFER_WRITABLE
3169 if (PerlIO_fast_gets(f) && PerlIO_has_base(f)) {
3170 /* Fake ungetc() to the real buffer in case system's ungetc
3173 STDCHAR *base = (STDCHAR*)PerlSIO_get_base(stdio);
3174 SSize_t cnt = PerlSIO_get_cnt(stdio);
3175 STDCHAR *ptr = (STDCHAR*)PerlSIO_get_ptr(stdio);
3176 if (ptr == base+1) {
3177 *--ptr = (STDCHAR) c;
3178 PerlIOStdio_set_ptrcnt(aTHX_ f,ptr,cnt+1);
3179 if (PerlSIO_feof(stdio))
3180 PerlSIO_clearerr(stdio);
3186 if (PerlIO_has_cntptr(f)) {
3188 if (PerlIOStdio_unread(aTHX_ f,&ch,1) == 1) {
3195 /* An ungetc()d char is handled separately from the regular
3196 * buffer, so we stuff it in the buffer ourselves.
3197 * Should never get called as should hit code above
3199 *(--((*stdio)->_ptr)) = (unsigned char) c;
3202 /* If buffer snoop scheme above fails fall back to
3205 if (PerlSIO_ungetc(c, stdio) != c)
3213 PerlIO_funcs PerlIO_stdio = {
3214 sizeof(PerlIO_funcs),
3216 sizeof(PerlIOStdio),
3217 PERLIO_K_BUFFERED|PERLIO_K_RAW,
3221 PerlIOBase_binmode, /* binmode */
3235 PerlIOStdio_clearerr,
3236 PerlIOStdio_setlinebuf,
3238 PerlIOStdio_get_base,
3239 PerlIOStdio_get_bufsiz,
3244 #ifdef USE_STDIO_PTR
3245 PerlIOStdio_get_ptr,
3246 PerlIOStdio_get_cnt,
3247 # if defined(HAS_FAST_STDIO) && defined(USE_FAST_STDIO)
3248 PerlIOStdio_set_ptrcnt,
3251 # endif /* HAS_FAST_STDIO && USE_FAST_STDIO */
3256 #endif /* USE_STDIO_PTR */
3259 /* Note that calls to PerlIO_exportFILE() are reversed using
3260 * PerlIO_releaseFILE(), not importFILE. */
3262 PerlIO_exportFILE(PerlIO * f, const char *mode)
3266 if (PerlIOValid(f)) {
3269 if (!mode || !*mode) {
3270 mode = PerlIO_modestr(f, buf);
3272 stdio = PerlSIO_fdopen(PerlIO_fileno(f), mode);
3275 /* De-link any lower layers so new :stdio sticks */
3277 if ((f = PerlIO_push(aTHX_ f, &PerlIO_stdio, buf, Nullsv))) {
3278 PerlIOStdio *s = PerlIOSelf(f, PerlIOStdio);
3280 /* Link previous lower layers under new one */
3284 /* restore layers list */
3294 PerlIO_findFILE(PerlIO *f)
3298 if (l->tab == &PerlIO_stdio) {
3299 PerlIOStdio *s = PerlIOSelf(&l, PerlIOStdio);
3302 l = *PerlIONext(&l);
3304 /* Uses fallback "mode" via PerlIO_modestr() in PerlIO_exportFILE */
3305 return PerlIO_exportFILE(f, Nullch);
3308 /* Use this to reverse PerlIO_exportFILE calls. */
3310 PerlIO_releaseFILE(PerlIO *p, FILE *f)
3314 if (l->tab == &PerlIO_stdio) {
3315 PerlIOStdio *s = PerlIOSelf(&l, PerlIOStdio);
3316 if (s->stdio == f) {
3318 PerlIO_pop(aTHX_ p);
3327 /*--------------------------------------------------------------------------------------*/
3329 * perlio buffer layer
3333 PerlIOBuf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
3335 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3336 int fd = PerlIO_fileno(f);
3337 if (fd >= 0 && PerlLIO_isatty(fd)) {
3338 PerlIOBase(f)->flags |= PERLIO_F_LINEBUF | PERLIO_F_TTY;
3340 if (*PerlIONext(f)) {
3341 Off_t posn = PerlIO_tell(PerlIONext(f));
3342 if (posn != (Off_t) - 1) {
3346 return PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
3350 PerlIOBuf_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
3351 IV n, const char *mode, int fd, int imode, int perm,
3352 PerlIO *f, int narg, SV **args)
3354 if (PerlIOValid(f)) {
3355 PerlIO *next = PerlIONext(f);
3356 PerlIO_funcs *tab = PerlIO_layer_fetch(aTHX_ layers, n - 1, PerlIOBase(next)->tab);
3357 next = (*tab->Open) (aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
3359 if (!next || (*PerlIOBase(f)->tab->Pushed) (aTHX_ f, mode, PerlIOArg, self) != 0) {
3364 PerlIO_funcs *tab = PerlIO_layer_fetch(aTHX_ layers, n - 1, PerlIO_default_btm());
3372 f = (*tab->Open) (aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
3375 if (PerlIO_push(aTHX_ f, self, mode, PerlIOArg) == 0) {
3377 * if push fails during open, open fails. close will pop us.
3382 fd = PerlIO_fileno(f);
3383 if (init && fd == 2) {
3385 * Initial stderr is unbuffered
3387 PerlIOBase(f)->flags |= PERLIO_F_UNBUF;
3389 #ifdef PERLIO_USING_CRLF
3390 # ifdef PERLIO_IS_BINMODE_FD
3391 if (PERLIO_IS_BINMODE_FD(fd))
3392 PerlIO_binmode(aTHX_ f, '<'/*not used*/, O_BINARY, Nullch);
3396 * do something about failing setmode()? --jhi
3398 PerlLIO_setmode(fd, O_BINARY);
3407 * This "flush" is akin to sfio's sync in that it handles files in either
3408 * read or write state
3411 PerlIOBuf_flush(pTHX_ PerlIO *f)
3413 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3415 PerlIO *n = PerlIONext(f);
3416 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF) {
3418 * write() the buffer
3420 STDCHAR *buf = b->buf;
3422 while (p < b->ptr) {
3423 SSize_t count = PerlIO_write(n, p, b->ptr - p);
3427 else if (count < 0 || PerlIO_error(n)) {
3428 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
3433 b->posn += (p - buf);
3435 else if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3436 STDCHAR *buf = PerlIO_get_base(f);
3438 * Note position change
3440 b->posn += (b->ptr - buf);
3441 if (b->ptr < b->end) {
3442 /* We did not consume all of it - try and seek downstream to
3443 our logical position
3445 if (PerlIOValid(n) && PerlIO_seek(n, b->posn, SEEK_SET) == 0) {
3446 /* Reload n as some layers may pop themselves on seek */
3447 b->posn = PerlIO_tell(n = PerlIONext(f));
3450 /* Seek failed (e.g. pipe or tty). Do NOT clear buffer or pre-read
3451 data is lost for good - so return saying "ok" having undone
3454 b->posn -= (b->ptr - buf);
3459 b->ptr = b->end = b->buf;
3460 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3461 /* We check for Valid because of dubious decision to make PerlIO_flush(NULL) flush all */
3462 if (PerlIOValid(n) && PerlIO_flush(n) != 0)
3468 PerlIOBuf_fill(pTHX_ PerlIO *f)
3470 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3471 PerlIO *n = PerlIONext(f);
3474 * Down-stream flush is defined not to loose read data so is harmless.
3475 * we would not normally be fill'ing if there was data left in anycase.
3477 if (PerlIO_flush(f) != 0)
3479 if (PerlIOBase(f)->flags & PERLIO_F_TTY)
3480 PerlIOBase_flush_linebuf(aTHX);
3483 PerlIO_get_base(f); /* allocate via vtable */
3485 b->ptr = b->end = b->buf;
3487 if (!PerlIOValid(n)) {
3488 PerlIOBase(f)->flags |= PERLIO_F_EOF;
3492 if (PerlIO_fast_gets(n)) {
3494 * Layer below is also buffered. We do _NOT_ want to call its
3495 * ->Read() because that will loop till it gets what we asked for
3496 * which may hang on a pipe etc. Instead take anything it has to
3497 * hand, or ask it to fill _once_.
3499 avail = PerlIO_get_cnt(n);
3501 avail = PerlIO_fill(n);
3503 avail = PerlIO_get_cnt(n);
3505 if (!PerlIO_error(n) && PerlIO_eof(n))
3510 STDCHAR *ptr = PerlIO_get_ptr(n);
3511 SSize_t cnt = avail;
3512 if (avail > (SSize_t)b->bufsiz)
3514 Copy(ptr, b->buf, avail, STDCHAR);
3515 PerlIO_set_ptrcnt(n, ptr + avail, cnt - avail);
3519 avail = PerlIO_read(n, b->ptr, b->bufsiz);
3523 PerlIOBase(f)->flags |= PERLIO_F_EOF;
3525 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
3528 b->end = b->buf + avail;
3529 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3534 PerlIOBuf_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
3536 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3537 if (PerlIOValid(f)) {
3540 return PerlIOBase_read(aTHX_ f, vbuf, count);
3546 PerlIOBuf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3548 const STDCHAR *buf = (const STDCHAR *) vbuf + count;
3549 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3552 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
3557 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3559 * Buffer is already a read buffer, we can overwrite any chars
3560 * which have been read back to buffer start
3562 avail = (b->ptr - b->buf);
3566 * Buffer is idle, set it up so whole buffer is available for
3570 b->end = b->buf + avail;
3572 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3574 * Buffer extends _back_ from where we are now
3576 b->posn -= b->bufsiz;
3578 if (avail > (SSize_t) count) {
3580 * If we have space for more than count, just move count
3588 * In simple stdio-like ungetc() case chars will be already
3591 if (buf != b->ptr) {
3592 Copy(buf, b->ptr, avail, STDCHAR);
3596 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
3600 unread += PerlIOBase_unread(aTHX_ f, vbuf, count);
3606 PerlIOBuf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3608 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3609 const STDCHAR *buf = (const STDCHAR *) vbuf;
3613 if (!(PerlIOBase(f)->flags & PERLIO_F_CANWRITE))
3615 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3616 if (PerlIO_flush(f) != 0) {
3621 SSize_t avail = b->bufsiz - (b->ptr - b->buf);
3622 if ((SSize_t) count < avail)
3624 PerlIOBase(f)->flags |= PERLIO_F_WRBUF;
3625 if (PerlIOBase(f)->flags & PERLIO_F_LINEBUF) {
3640 Copy(buf, b->ptr, avail, STDCHAR);
3647 if (b->ptr >= (b->buf + b->bufsiz))
3650 if (PerlIOBase(f)->flags & PERLIO_F_UNBUF)
3656 PerlIOBuf_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3659 if ((code = PerlIO_flush(f)) == 0) {
3660 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3661 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
3662 code = PerlIO_seek(PerlIONext(f), offset, whence);
3664 b->posn = PerlIO_tell(PerlIONext(f));
3671 PerlIOBuf_tell(pTHX_ PerlIO *f)
3673 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3675 * b->posn is file position where b->buf was read, or will be written
3677 Off_t posn = b->posn;
3678 if ((PerlIOBase(f)->flags & PERLIO_F_APPEND) &&
3679 (PerlIOBase(f)->flags & PERLIO_F_WRBUF)) {
3681 /* As O_APPEND files are normally shared in some sense it is better
3686 /* when file is NOT shared then this is sufficient */
3687 PerlIO_seek(PerlIONext(f),0, SEEK_END);
3689 posn = b->posn = PerlIO_tell(PerlIONext(f));
3693 * If buffer is valid adjust position by amount in buffer
3695 posn += (b->ptr - b->buf);
3701 PerlIOBuf_popped(pTHX_ PerlIO *f)
3703 IV code = PerlIOBase_popped(aTHX_ f);
3704 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3705 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
3709 b->ptr = b->end = b->buf;
3710 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3715 PerlIOBuf_close(pTHX_ PerlIO *f)
3717 IV code = PerlIOBase_close(aTHX_ f);
3718 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3719 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
3723 b->ptr = b->end = b->buf;
3724 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3729 PerlIOBuf_get_ptr(pTHX_ PerlIO *f)
3731 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3738 PerlIOBuf_get_cnt(pTHX_ PerlIO *f)
3740 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3743 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF)
3744 return (b->end - b->ptr);
3749 PerlIOBuf_get_base(pTHX_ PerlIO *f)
3751 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3756 Newz('B',b->buf,b->bufsiz, STDCHAR);
3758 b->buf = (STDCHAR *) & b->oneword;
3759 b->bufsiz = sizeof(b->oneword);
3768 PerlIOBuf_bufsiz(pTHX_ PerlIO *f)
3770 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3773 return (b->end - b->buf);
3777 PerlIOBuf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
3779 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3783 if (PerlIO_get_cnt(f) != cnt || b->ptr < b->buf) {
3784 assert(PerlIO_get_cnt(f) == cnt);
3785 assert(b->ptr >= b->buf);
3787 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3791 PerlIOBuf_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
3793 return PerlIOBase_dup(aTHX_ f, o, param, flags);
3798 PerlIO_funcs PerlIO_perlio = {
3799 sizeof(PerlIO_funcs),
3802 PERLIO_K_BUFFERED|PERLIO_K_RAW,
3806 PerlIOBase_binmode, /* binmode */
3820 PerlIOBase_clearerr,
3821 PerlIOBase_setlinebuf,
3826 PerlIOBuf_set_ptrcnt,
3829 /*--------------------------------------------------------------------------------------*/
3831 * Temp layer to hold unread chars when cannot do it any other way
3835 PerlIOPending_fill(pTHX_ PerlIO *f)
3838 * Should never happen
3845 PerlIOPending_close(pTHX_ PerlIO *f)
3848 * A tad tricky - flush pops us, then we close new top
3851 return PerlIO_close(f);
3855 PerlIOPending_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3858 * A tad tricky - flush pops us, then we seek new top
3861 return PerlIO_seek(f, offset, whence);
3866 PerlIOPending_flush(pTHX_ PerlIO *f)
3868 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3869 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
3873 PerlIO_pop(aTHX_ f);
3878 PerlIOPending_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
3884 PerlIOBuf_set_ptrcnt(aTHX_ f, ptr, cnt);
3889 PerlIOPending_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
3891 IV code = PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
3892 PerlIOl *l = PerlIOBase(f);
3894 * Our PerlIO_fast_gets must match what we are pushed on, or sv_gets()
3895 * etc. get muddled when it changes mid-string when we auto-pop.
3897 l->flags = (l->flags & ~(PERLIO_F_FASTGETS | PERLIO_F_UTF8)) |
3898 (PerlIOBase(PerlIONext(f))->
3899 flags & (PERLIO_F_FASTGETS | PERLIO_F_UTF8));
3904 PerlIOPending_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
3906 SSize_t avail = PerlIO_get_cnt(f);
3908 if ((SSize_t)count < avail)
3911 got = PerlIOBuf_read(aTHX_ f, vbuf, avail);
3912 if (got >= 0 && got < (SSize_t)count) {
3914 PerlIO_read(f, ((STDCHAR *) vbuf) + got, count - got);
3915 if (more >= 0 || got == 0)
3921 PerlIO_funcs PerlIO_pending = {
3922 sizeof(PerlIO_funcs),
3925 PERLIO_K_BUFFERED|PERLIO_K_RAW, /* not sure about RAW here */
3926 PerlIOPending_pushed,
3929 PerlIOBase_binmode, /* binmode */
3938 PerlIOPending_close,
3939 PerlIOPending_flush,
3943 PerlIOBase_clearerr,
3944 PerlIOBase_setlinebuf,
3949 PerlIOPending_set_ptrcnt,
3954 /*--------------------------------------------------------------------------------------*/
3956 * crlf - translation On read translate CR,LF to "\n" we do this by
3957 * overriding ptr/cnt entries to hand back a line at a time and keeping a
3958 * record of which nl we "lied" about. On write translate "\n" to CR,LF
3962 PerlIOBuf base; /* PerlIOBuf stuff */
3963 STDCHAR *nl; /* Position of crlf we "lied" about in the
3968 PerlIOCrlf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
3971 PerlIOBase(f)->flags |= PERLIO_F_CRLF;
3972 code = PerlIOBuf_pushed(aTHX_ f, mode, arg, tab);
3974 PerlIO_debug("PerlIOCrlf_pushed f=%p %s %s fl=%08" UVxf "\n",
3975 f, PerlIOBase(f)->tab->name, (mode) ? mode : "(Null)",
3976 PerlIOBase(f)->flags);
3983 PerlIOCrlf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3985 PerlIOCrlf *c = PerlIOSelf(f, PerlIOCrlf);
3990 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF))
3991 return PerlIOBuf_unread(aTHX_ f, vbuf, count);
3993 const STDCHAR *buf = (const STDCHAR *) vbuf + count;
3994 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3996 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
4001 if (!(PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4002 b->end = b->ptr = b->buf + b->bufsiz;
4003 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4004 b->posn -= b->bufsiz;
4006 while (count > 0 && b->ptr > b->buf) {
4009 if (b->ptr - 2 >= b->buf) {
4032 PerlIOCrlf_get_cnt(pTHX_ PerlIO *f)
4034 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4037 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
4038 PerlIOCrlf *c = PerlIOSelf(f, PerlIOCrlf);
4039 if ((PerlIOBase(f)->flags & PERLIO_F_CRLF) && (!c->nl || *c->nl == 0xd)) {
4040 STDCHAR *nl = (c->nl) ? c->nl : b->ptr;
4042 while (nl < b->end && *nl != 0xd)
4044 if (nl < b->end && *nl == 0xd) {
4046 if (nl + 1 < b->end) {
4053 * Not CR,LF but just CR
4061 * Blast - found CR as last char in buffer
4066 * They may not care, defer work as long as
4070 return (nl - b->ptr);
4074 b->ptr++; /* say we have read it as far as
4075 * flush() is concerned */
4076 b->buf++; /* Leave space in front of buffer */
4077 /* Note as we have moved buf up flush's
4079 will naturally make posn point at CR
4081 b->bufsiz--; /* Buffer is thus smaller */
4082 code = PerlIO_fill(f); /* Fetch some more */
4083 b->bufsiz++; /* Restore size for next time */
4084 b->buf--; /* Point at space */
4085 b->ptr = nl = b->buf; /* Which is what we hand
4087 *nl = 0xd; /* Fill in the CR */
4089 goto test; /* fill() call worked */
4091 * CR at EOF - just fall through
4093 /* Should we clear EOF though ??? */
4098 return (((c->nl) ? (c->nl + 1) : b->end) - b->ptr);
4104 PerlIOCrlf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
4106 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4107 PerlIOCrlf *c = PerlIOSelf(f, PerlIOCrlf);
4113 if (ptr == b->end && *c->nl == 0xd) {
4114 /* Defered CR at end of buffer case - we lied about count */
4126 * Test code - delete when it works ...
4128 IV flags = PerlIOBase(f)->flags;
4129 STDCHAR *chk = (c->nl) ? (c->nl+1) : b->end;
4130 if (ptr+cnt == c->nl && c->nl+1 == b->end && *c->nl == 0xd) {
4131 /* Defered CR at end of buffer case - we lied about count */
4137 Perl_croak(aTHX_ "ptr wrong %p != %p fl=%08" UVxf
4138 " nl=%p e=%p for %d", ptr, chk, flags, c->nl,
4146 * They have taken what we lied about
4154 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4158 PerlIOCrlf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4160 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF))
4161 return PerlIOBuf_write(aTHX_ f, vbuf, count);
4163 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4164 const STDCHAR *buf = (const STDCHAR *) vbuf;
4165 const STDCHAR *ebuf = buf + count;
4168 if (!(PerlIOBase(f)->flags & PERLIO_F_CANWRITE))
4170 while (buf < ebuf) {
4171 STDCHAR *eptr = b->buf + b->bufsiz;
4172 PerlIOBase(f)->flags |= PERLIO_F_WRBUF;
4173 while (buf < ebuf && b->ptr < eptr) {
4175 if ((b->ptr + 2) > eptr) {
4183 *(b->ptr)++ = 0xd; /* CR */
4184 *(b->ptr)++ = 0xa; /* LF */
4186 if (PerlIOBase(f)->flags & PERLIO_F_LINEBUF) {
4196 if (b->ptr >= eptr) {
4202 if (PerlIOBase(f)->flags & PERLIO_F_UNBUF)
4204 return (buf - (STDCHAR *) vbuf);
4209 PerlIOCrlf_flush(pTHX_ PerlIO *f)
4211 PerlIOCrlf *c = PerlIOSelf(f, PerlIOCrlf);
4216 return PerlIOBuf_flush(aTHX_ f);
4220 PerlIOCrlf_binmode(pTHX_ PerlIO *f)
4222 if ((PerlIOBase(f)->flags & PERLIO_F_CRLF)) {
4223 /* In text mode - flush any pending stuff and flip it */
4224 PerlIOBase(f)->flags &= ~PERLIO_F_CRLF;
4225 #ifndef PERLIO_USING_CRLF
4226 /* CRLF is unusual case - if this is just the :crlf layer pop it */
4227 if (PerlIOBase(f)->tab == &PerlIO_crlf) {
4228 PerlIO_pop(aTHX_ f);
4235 PerlIO_funcs PerlIO_crlf = {
4236 sizeof(PerlIO_funcs),
4239 PERLIO_K_BUFFERED | PERLIO_K_CANCRLF | PERLIO_K_RAW,
4241 PerlIOBuf_popped, /* popped */
4243 PerlIOCrlf_binmode, /* binmode */
4247 PerlIOBuf_read, /* generic read works with ptr/cnt lies
4249 PerlIOCrlf_unread, /* Put CR,LF in buffer for each '\n' */
4250 PerlIOCrlf_write, /* Put CR,LF in buffer for each '\n' */
4258 PerlIOBase_clearerr,
4259 PerlIOBase_setlinebuf,
4264 PerlIOCrlf_set_ptrcnt,
4268 /*--------------------------------------------------------------------------------------*/
4270 * mmap as "buffer" layer
4274 PerlIOBuf base; /* PerlIOBuf stuff */
4275 Mmap_t mptr; /* Mapped address */
4276 Size_t len; /* mapped length */
4277 STDCHAR *bbuf; /* malloced buffer if map fails */
4280 static size_t page_size = 0;
4283 PerlIOMmap_map(pTHX_ PerlIO *f)
4285 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4286 IV flags = PerlIOBase(f)->flags;
4290 if (flags & PERLIO_F_CANREAD) {
4291 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4292 int fd = PerlIO_fileno(f);
4294 code = Fstat(fd, &st);
4295 if (code == 0 && S_ISREG(st.st_mode)) {
4296 SSize_t len = st.st_size - b->posn;
4300 #if defined(HAS_SYSCONF) && (defined(_SC_PAGESIZE) || defined(_SC_PAGE_SIZE))
4302 SETERRNO(0, SS_NORMAL);
4303 # ifdef _SC_PAGESIZE
4304 page_size = sysconf(_SC_PAGESIZE);
4306 page_size = sysconf(_SC_PAGE_SIZE);
4308 if ((long) page_size < 0) {
4313 (void) SvUPGRADE(error, SVt_PV);
4314 msg = SvPVx(error, n_a);
4315 Perl_croak(aTHX_ "panic: sysconf: %s",
4320 "panic: sysconf: pagesize unknown");
4324 # ifdef HAS_GETPAGESIZE
4325 page_size = getpagesize();
4327 # if defined(I_SYS_PARAM) && defined(PAGESIZE)
4328 page_size = PAGESIZE; /* compiletime, bad */
4332 if ((IV) page_size <= 0)
4333 Perl_croak(aTHX_ "panic: bad pagesize %" IVdf,
4338 * This is a hack - should never happen - open should
4341 b->posn = PerlIO_tell(PerlIONext(f));
4343 posn = (b->posn / page_size) * page_size;
4344 len = st.st_size - posn;
4345 m->mptr = mmap(NULL, len, PROT_READ, MAP_SHARED, fd, posn);
4346 if (m->mptr && m->mptr != (Mmap_t) - 1) {
4347 #if 0 && defined(HAS_MADVISE) && defined(MADV_SEQUENTIAL)
4348 madvise(m->mptr, len, MADV_SEQUENTIAL);
4350 #if 0 && defined(HAS_MADVISE) && defined(MADV_WILLNEED)
4351 madvise(m->mptr, len, MADV_WILLNEED);
4353 PerlIOBase(f)->flags =
4354 (flags & ~PERLIO_F_EOF) | PERLIO_F_RDBUF;
4355 b->end = ((STDCHAR *) m->mptr) + len;
4356 b->buf = ((STDCHAR *) m->mptr) + (b->posn - posn);
4365 PerlIOBase(f)->flags =
4366 flags | PERLIO_F_EOF | PERLIO_F_RDBUF;
4368 b->ptr = b->end = b->ptr;
4377 PerlIOMmap_unmap(pTHX_ PerlIO *f)
4379 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4380 PerlIOBuf *b = &m->base;
4384 code = munmap(m->mptr, m->len);
4388 if (PerlIO_seek(PerlIONext(f), b->posn, SEEK_SET) != 0)
4391 b->ptr = b->end = b->buf;
4392 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
4398 PerlIOMmap_get_base(pTHX_ PerlIO *f)
4400 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4401 PerlIOBuf *b = &m->base;
4402 if (b->buf && (PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4404 * Already have a readbuffer in progress
4410 * We have a write buffer or flushed PerlIOBuf read buffer
4412 m->bbuf = b->buf; /* save it in case we need it again */
4413 b->buf = NULL; /* Clear to trigger below */
4416 PerlIOMmap_map(aTHX_ f); /* Try and map it */
4419 * Map did not work - recover PerlIOBuf buffer if we have one
4424 b->ptr = b->end = b->buf;
4427 return PerlIOBuf_get_base(aTHX_ f);
4431 PerlIOMmap_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4433 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4434 PerlIOBuf *b = &m->base;
4435 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
4437 if (b->ptr && (b->ptr - count) >= b->buf
4438 && memEQ(b->ptr - count, vbuf, count)) {
4440 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
4445 * Loose the unwritable mapped buffer
4449 * If flush took the "buffer" see if we have one from before
4451 if (!b->buf && m->bbuf)
4454 PerlIOBuf_get_base(aTHX_ f);
4458 return PerlIOBuf_unread(aTHX_ f, vbuf, count);
4462 PerlIOMmap_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4464 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4465 PerlIOBuf *b = &m->base;
4466 if (!b->buf || !(PerlIOBase(f)->flags & PERLIO_F_WRBUF)) {
4468 * No, or wrong sort of, buffer
4471 if (PerlIOMmap_unmap(aTHX_ f) != 0)
4475 * If unmap took the "buffer" see if we have one from before
4477 if (!b->buf && m->bbuf)
4480 PerlIOBuf_get_base(aTHX_ f);
4484 return PerlIOBuf_write(aTHX_ f, vbuf, count);
4488 PerlIOMmap_flush(pTHX_ PerlIO *f)
4490 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4491 PerlIOBuf *b = &m->base;
4492 IV code = PerlIOBuf_flush(aTHX_ f);
4494 * Now we are "synced" at PerlIOBuf level
4501 if (PerlIOMmap_unmap(aTHX_ f) != 0)
4506 * We seem to have a PerlIOBuf buffer which was not mapped
4507 * remember it in case we need one later
4516 PerlIOMmap_fill(pTHX_ PerlIO *f)
4518 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4519 IV code = PerlIO_flush(f);
4520 if (code == 0 && !b->buf) {
4521 code = PerlIOMmap_map(aTHX_ f);
4523 if (code == 0 && !(PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4524 code = PerlIOBuf_fill(aTHX_ f);
4530 PerlIOMmap_close(pTHX_ PerlIO *f)
4532 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4533 PerlIOBuf *b = &m->base;
4534 IV code = PerlIO_flush(f);
4538 b->ptr = b->end = b->buf;
4540 if (PerlIOBuf_close(aTHX_ f) != 0)
4546 PerlIOMmap_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
4548 return PerlIOBase_dup(aTHX_ f, o, param, flags);
4552 PerlIO_funcs PerlIO_mmap = {
4553 sizeof(PerlIO_funcs),
4556 PERLIO_K_BUFFERED|PERLIO_K_RAW,
4560 PerlIOBase_binmode, /* binmode */
4574 PerlIOBase_clearerr,
4575 PerlIOBase_setlinebuf,
4576 PerlIOMmap_get_base,
4580 PerlIOBuf_set_ptrcnt,
4583 #endif /* HAS_MMAP */
4586 Perl_PerlIO_stdin(pTHX)
4589 PerlIO_stdstreams(aTHX);
4591 return &PL_perlio[1];
4595 Perl_PerlIO_stdout(pTHX)
4598 PerlIO_stdstreams(aTHX);
4600 return &PL_perlio[2];
4604 Perl_PerlIO_stderr(pTHX)
4607 PerlIO_stdstreams(aTHX);
4609 return &PL_perlio[3];
4612 /*--------------------------------------------------------------------------------------*/
4615 PerlIO_getname(PerlIO *f, char *buf)
4620 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
4622 name = fgetname(stdio, buf);
4624 Perl_croak(aTHX_ "Don't know how to get file name");
4630 /*--------------------------------------------------------------------------------------*/
4632 * Functions which can be called on any kind of PerlIO implemented in
4636 #undef PerlIO_fdopen
4638 PerlIO_fdopen(int fd, const char *mode)
4641 return PerlIO_openn(aTHX_ Nullch, mode, fd, 0, 0, NULL, 0, NULL);
4646 PerlIO_open(const char *path, const char *mode)
4649 SV *name = sv_2mortal(newSVpvn(path, strlen(path)));
4650 return PerlIO_openn(aTHX_ Nullch, mode, -1, 0, 0, NULL, 1, &name);
4653 #undef Perlio_reopen
4655 PerlIO_reopen(const char *path, const char *mode, PerlIO *f)
4658 SV *name = sv_2mortal(newSVpvn(path, strlen(path)));
4659 return PerlIO_openn(aTHX_ Nullch, mode, -1, 0, 0, f, 1, &name);
4664 PerlIO_getc(PerlIO *f)
4668 SSize_t count = PerlIO_read(f, buf, 1);
4670 return (unsigned char) buf[0];
4675 #undef PerlIO_ungetc
4677 PerlIO_ungetc(PerlIO *f, int ch)
4682 if (PerlIO_unread(f, &buf, 1) == 1)
4690 PerlIO_putc(PerlIO *f, int ch)
4694 return PerlIO_write(f, &buf, 1);
4699 PerlIO_puts(PerlIO *f, const char *s)
4702 STRLEN len = strlen(s);
4703 return PerlIO_write(f, s, len);
4706 #undef PerlIO_rewind
4708 PerlIO_rewind(PerlIO *f)
4711 PerlIO_seek(f, (Off_t) 0, SEEK_SET);
4715 #undef PerlIO_vprintf
4717 PerlIO_vprintf(PerlIO *f, const char *fmt, va_list ap)
4720 SV *sv = newSVpvn("", 0);
4726 Perl_va_copy(ap, apc);
4727 sv_vcatpvf(sv, fmt, &apc);
4729 sv_vcatpvf(sv, fmt, &ap);
4732 wrote = PerlIO_write(f, s, len);
4737 #undef PerlIO_printf
4739 PerlIO_printf(PerlIO *f, const char *fmt, ...)
4744 result = PerlIO_vprintf(f, fmt, ap);
4749 #undef PerlIO_stdoutf
4751 PerlIO_stdoutf(const char *fmt, ...)
4757 result = PerlIO_vprintf(PerlIO_stdout(), fmt, ap);
4762 #undef PerlIO_tmpfile
4764 PerlIO_tmpfile(void)
4770 GV *gv = gv_fetchpv("File::Temp::tempfile", FALSE, SVt_PVCV);
4774 Perl_load_module(aTHX_ PERL_LOADMOD_NOIMPORT,
4775 newSVpvn("File::Temp", 10), Nullsv, Nullsv, Nullsv);
4776 gv = gv_fetchpv("File::Temp::tempfile", FALSE, SVt_PVCV);
4777 GvIMPORTED_CV_on(gv);
4781 if (gv && GvCV(gv)) {
4787 if (call_sv((SV*)GvCV(gv), G_SCALAR)) {
4788 GV *gv = (GV*)SvRV(newSVsv(*PL_stack_sp--));
4789 IO *io = gv ? GvIO(gv) : 0;
4790 fd = io ? PerlIO_fileno(IoIFP(io)) : -1;
4799 f = PerlIO_fdopen(fd, "w+");
4802 PerlIOBase(f)->flags |= PERLIO_F_TEMP;
4803 PerlLIO_unlink(SvPVX(sv));
4814 #endif /* USE_SFIO */
4815 #endif /* PERLIO_IS_STDIO */
4817 /*======================================================================================*/
4819 * Now some functions in terms of above which may be needed even if we are
4820 * not in true PerlIO mode
4824 #undef PerlIO_setpos
4826 PerlIO_setpos(PerlIO *f, SV *pos)
4831 Off_t *posn = (Off_t *) SvPV(pos, len);
4832 if (f && len == sizeof(Off_t))
4833 return PerlIO_seek(f, *posn, SEEK_SET);
4835 SETERRNO(EINVAL, SS_IVCHAN);
4839 #undef PerlIO_setpos
4841 PerlIO_setpos(PerlIO *f, SV *pos)
4846 Fpos_t *fpos = (Fpos_t *) SvPV(pos, len);
4847 if (f && len == sizeof(Fpos_t)) {
4848 #if defined(USE_64_BIT_STDIO) && defined(USE_FSETPOS64)
4849 return fsetpos64(f, fpos);
4851 return fsetpos(f, fpos);
4855 SETERRNO(EINVAL, SS_IVCHAN);
4861 #undef PerlIO_getpos
4863 PerlIO_getpos(PerlIO *f, SV *pos)
4866 Off_t posn = PerlIO_tell(f);
4867 sv_setpvn(pos, (char *) &posn, sizeof(posn));
4868 return (posn == (Off_t) - 1) ? -1 : 0;
4871 #undef PerlIO_getpos
4873 PerlIO_getpos(PerlIO *f, SV *pos)
4878 #if defined(USE_64_BIT_STDIO) && defined(USE_FSETPOS64)
4879 code = fgetpos64(f, &fpos);
4881 code = fgetpos(f, &fpos);
4883 sv_setpvn(pos, (char *) &fpos, sizeof(fpos));
4888 #if (defined(PERLIO_IS_STDIO) || !defined(USE_SFIO)) && !defined(HAS_VPRINTF)
4891 vprintf(char *pat, char *args)
4893 _doprnt(pat, args, stdout);
4894 return 0; /* wrong, but perl doesn't use the return
4899 vfprintf(FILE *fd, char *pat, char *args)
4901 _doprnt(pat, args, fd);
4902 return 0; /* wrong, but perl doesn't use the return
4908 #ifndef PerlIO_vsprintf
4910 PerlIO_vsprintf(char *s, int n, const char *fmt, va_list ap)
4912 int val = vsprintf(s, fmt, ap);
4914 if (strlen(s) >= (STRLEN) n) {
4916 (void) PerlIO_puts(Perl_error_log,
4917 "panic: sprintf overflow - memory corrupted!\n");
4925 #ifndef PerlIO_sprintf
4927 PerlIO_sprintf(char *s, int n, const char *fmt, ...)
4932 result = PerlIO_vsprintf(s, n, fmt, ap);