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 *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 *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 *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 *tab = PerlIOBase(f)->tab; \
107 if (tab && tab->callback) \
108 (*tab->callback) args; \
110 SETERRNO(EINVAL, LIB_INVARG); \
113 SETERRNO(EBADF, SS_IVCHAN)
117 perlsio_binmode(FILE *fp, int iotype, int mode)
120 * This used to be contents of do_binmode in doio.c
123 # if defined(atarist) || defined(__MINT__)
126 ((FILE *) fp)->_flag |= _IOBIN;
128 ((FILE *) fp)->_flag &= ~_IOBIN;
135 if (PerlLIO_setmode(fp, mode) != -1) {
137 if (PerlLIO_setmode(fileno(fp), mode) != -1) {
139 # if defined(WIN32) && defined(__BORLANDC__)
141 * The translation mode of the stream is maintained independent of
142 * the translation mode of the fd in the Borland RTL (heavy
143 * digging through their runtime sources reveal). User has to set
144 * the mode explicitly for the stream (though they don't document
145 * this anywhere). GSAR 97-5-24
151 fp->flags &= ~_F_BIN;
159 # if defined(USEMYBINMODE)
161 if (my_binmode(fp, iotype, mode) != FALSE)
176 #define O_ACCMODE 3 /* Assume traditional implementation */
180 PerlIO_intmode2str(int rawmode, char *mode, int *writing)
182 const int result = rawmode & O_ACCMODE;
187 ptype = IoTYPE_RDONLY;
190 ptype = IoTYPE_WRONLY;
198 *writing = (result != O_RDONLY);
200 if (result == O_RDONLY) {
204 else if (rawmode & O_APPEND) {
206 if (result != O_WRONLY)
211 if (result == O_WRONLY)
218 if (rawmode & O_BINARY)
224 #ifndef PERLIO_LAYERS
226 PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode, const char *names)
228 if (!names || !*names
229 || strEQ(names, ":crlf")
230 || strEQ(names, ":raw")
231 || strEQ(names, ":bytes")
235 Perl_croak(aTHX_ "Cannot apply \"%s\" in non-PerlIO perl", names);
243 PerlIO_destruct(pTHX)
248 PerlIO_binmode(pTHX_ PerlIO *fp, int iotype, int mode, const char *names)
256 return perlsio_binmode(fp, iotype, mode);
261 PerlIO_fdupopen(pTHX_ PerlIO *f, CLONE_PARAMS *param, int flags)
263 #if defined(PERL_MICRO) || defined(SYMBIAN)
266 #ifdef PERL_IMPLICIT_SYS
267 return PerlSIO_fdupopen(f);
270 return win32_fdupopen(f);
273 int fd = PerlLIO_dup(PerlIO_fileno(f));
276 int omode = fcntl(fd, F_GETFL);
278 omode = djgpp_get_stream_mode(f);
280 PerlIO_intmode2str(omode,mode,NULL);
281 /* the r+ is a hack */
282 return PerlIO_fdopen(fd, mode);
287 SETERRNO(EBADF, SS_IVCHAN);
297 * De-mux PerlIO_openn() into fdopen, freopen and fopen type entries
301 PerlIO_openn(pTHX_ const char *layers, const char *mode, int fd,
302 int imode, int perm, PerlIO *old, int narg, SV **args)
306 Perl_croak(aTHX_ "More than one argument to open");
308 if (*args == &PL_sv_undef)
309 return PerlIO_tmpfile();
311 const char *name = SvPV_nolen(*args);
312 if (*mode == IoTYPE_NUMERIC) {
313 fd = PerlLIO_open3(name, imode, perm);
315 return PerlIO_fdopen(fd, mode + 1);
318 return PerlIO_reopen(name, mode, old);
321 return PerlIO_open(name, mode);
326 return PerlIO_fdopen(fd, (char *) mode);
331 XS(XS_PerlIO__Layer__find)
335 Perl_croak(aTHX_ "Usage class->find(name[,load])");
337 const char *name = SvPV_nolen(ST(1));
338 ST(0) = (strEQ(name, "crlf")
339 || strEQ(name, "raw")) ? &PL_sv_yes : &PL_sv_undef;
346 Perl_boot_core_PerlIO(pTHX)
348 newXS("PerlIO::Layer::find", XS_PerlIO__Layer__find, __FILE__);
354 #ifdef PERLIO_IS_STDIO
360 * Does nothing (yet) except force this file to be included in perl
361 * binary. That allows this file to force inclusion of other functions
362 * that may be required by loadable extensions e.g. for
363 * FileHandle::tmpfile
367 #undef PerlIO_tmpfile
374 #else /* PERLIO_IS_STDIO */
382 * This section is just to make sure these functions get pulled in from
386 #undef PerlIO_tmpfile
397 * Force this file to be included in perl binary. Which allows this
398 * file to force inclusion of other functions that may be required by
399 * loadable extensions e.g. for FileHandle::tmpfile
403 * Hack sfio does its own 'autoflush' on stdout in common cases. Flush
404 * results in a lot of lseek()s to regular files and lot of small
407 sfset(sfstdout, SF_SHARE, 0);
410 /* This is not the reverse of PerlIO_exportFILE(), PerlIO_releaseFILE() is. */
412 PerlIO_importFILE(FILE *stdio, const char *mode)
414 const int fd = fileno(stdio);
415 if (!mode || !*mode) {
418 return PerlIO_fdopen(fd, mode);
422 PerlIO_findFILE(PerlIO *pio)
424 const int fd = PerlIO_fileno(pio);
425 FILE * const f = fdopen(fd, "r+");
427 if (!f && errno == EINVAL)
429 if (!f && errno == EINVAL)
436 /*======================================================================================*/
438 * Implement all the PerlIO interface ourselves.
444 * We _MUST_ have <unistd.h> if we are using lseek() and may have large
451 #include <sys/mman.h>
455 PerlIO_debug(const char *fmt, ...)
460 if (!PL_perlio_debug_fd && !PL_tainting && PL_uid == PL_euid && PL_gid == PL_egid) {
461 const char *s = PerlEnv_getenv("PERLIO_DEBUG");
463 PL_perlio_debug_fd = PerlLIO_open3(s, O_WRONLY | O_CREAT | O_APPEND, 0666);
465 PL_perlio_debug_fd = -1;
467 if (PL_perlio_debug_fd > 0) {
469 const char *s = CopFILE(PL_curcop);
472 /* Use fixed buffer as sv_catpvf etc. needs SVs */
476 len = sprintf(buffer, "%.40s:%" IVdf " ", s, (IV) CopLINE(PL_curcop));
477 vsprintf(buffer+len, fmt, ap);
478 PerlLIO_write(PL_perlio_debug_fd, buffer, strlen(buffer));
480 SV *sv = newSVpvn("", 0);
483 Perl_sv_catpvf(aTHX_ sv, "%s:%" IVdf " ", s,
484 (IV) CopLINE(PL_curcop));
485 Perl_sv_vcatpvf(aTHX_ sv, fmt, &ap);
488 PerlLIO_write(PL_perlio_debug_fd, s, len);
495 /*--------------------------------------------------------------------------------------*/
498 * Inner level routines
502 * Table of pointers to the PerlIO structs (malloc'ed)
504 #define PERLIO_TABLE_SIZE 64
507 PerlIO_allocate(pTHX)
510 * Find a free slot in the table, allocating new table as necessary
515 while ((f = *last)) {
517 last = (PerlIO **) (f);
518 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
524 Newz('I',f,PERLIO_TABLE_SIZE,PerlIO);
532 #undef PerlIO_fdupopen
534 PerlIO_fdupopen(pTHX_ PerlIO *f, CLONE_PARAMS *param, int flags)
536 if (PerlIOValid(f)) {
537 const PerlIO_funcs * const tab = PerlIOBase(f)->tab;
538 PerlIO_debug("fdupopen f=%p param=%p\n",(void*)f,(void*)param);
540 return (*tab->Dup)(aTHX_ PerlIO_allocate(aTHX), f, param, flags);
542 return PerlIOBase_dup(aTHX_ PerlIO_allocate(aTHX), f, param, flags);
546 SETERRNO(EBADF, SS_IVCHAN);
552 PerlIO_cleantable(pTHX_ PerlIO **tablep)
554 PerlIO *table = *tablep;
557 PerlIO_cleantable(aTHX_(PerlIO **) & (table[0]));
558 for (i = PERLIO_TABLE_SIZE - 1; i > 0; i--) {
559 PerlIO *f = table + i;
571 PerlIO_list_alloc(pTHX)
574 Newz('L', list, 1, PerlIO_list_t);
580 PerlIO_list_free(pTHX_ PerlIO_list_t *list)
583 if (--list->refcnt == 0) {
586 for (i = 0; i < list->cur; i++) {
587 if (list->array[i].arg)
588 SvREFCNT_dec(list->array[i].arg);
590 Safefree(list->array);
598 PerlIO_list_push(pTHX_ PerlIO_list_t *list, PerlIO_funcs *funcs, SV *arg)
601 if (list->cur >= list->len) {
604 Renew(list->array, list->len, PerlIO_pair_t);
606 New('l', list->array, list->len, PerlIO_pair_t);
608 p = &(list->array[list->cur++]);
610 if ((p->arg = arg)) {
611 (void)SvREFCNT_inc(arg);
616 PerlIO_clone_list(pTHX_ PerlIO_list_t *proto, CLONE_PARAMS *param)
618 PerlIO_list_t *list = (PerlIO_list_t *) NULL;
621 list = PerlIO_list_alloc(aTHX);
622 for (i=0; i < proto->cur; i++) {
624 if (proto->array[i].arg)
625 arg = PerlIO_sv_dup(aTHX_ proto->array[i].arg,param);
626 PerlIO_list_push(aTHX_ list, proto->array[i].funcs, arg);
633 PerlIO_clone(pTHX_ PerlInterpreter *proto, CLONE_PARAMS *param)
636 PerlIO **table = &proto->Iperlio;
639 PL_known_layers = PerlIO_clone_list(aTHX_ proto->Iknown_layers, param);
640 PL_def_layerlist = PerlIO_clone_list(aTHX_ proto->Idef_layerlist, param);
641 PerlIO_allocate(aTHX); /* root slot is never used */
642 PerlIO_debug("Clone %p from %p\n",aTHX,proto);
643 while ((f = *table)) {
645 table = (PerlIO **) (f++);
646 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
648 (void) fp_dup(f, 0, param);
657 PerlIO_destruct(pTHX)
659 PerlIO **table = &PL_perlio;
662 PerlIO_debug("Destruct %p\n",aTHX);
664 while ((f = *table)) {
666 table = (PerlIO **) (f++);
667 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
671 if (l->tab->kind & PERLIO_K_DESTRUCT) {
672 PerlIO_debug("Destruct popping %s\n", l->tab->name);
686 PerlIO_pop(pTHX_ PerlIO *f)
690 PerlIO_debug("PerlIO_pop f=%p %s\n", (void*)f, l->tab->name);
691 if (l->tab->Popped) {
693 * If popped returns non-zero do not free its layer structure
694 * it has either done so itself, or it is shared and still in
697 if ((*l->tab->Popped) (aTHX_ f) != 0)
705 /* Return as an array the stack of layers on a filehandle. Note that
706 * the stack is returned top-first in the array, and there are three
707 * times as many array elements as there are layers in the stack: the
708 * first element of a layer triplet is the name, the second one is the
709 * arguments, and the third one is the flags. */
712 PerlIO_get_layers(pTHX_ PerlIO *f)
716 if (PerlIOValid(f)) {
717 PerlIOl *l = PerlIOBase(f);
720 SV *name = l->tab && l->tab->name ?
721 newSVpv(l->tab->name, 0) : &PL_sv_undef;
722 SV *arg = l->tab && l->tab->Getarg ?
723 (*l->tab->Getarg)(aTHX_ &l, 0, 0) : &PL_sv_undef;
726 av_push(av, newSViv((IV)l->flags));
734 /*--------------------------------------------------------------------------------------*/
736 * XS Interface for perl code
740 PerlIO_find_layer(pTHX_ const char *name, STRLEN len, int load)
744 if ((SSize_t) len <= 0)
746 for (i = 0; i < PL_known_layers->cur; i++) {
747 PerlIO_funcs *f = PL_known_layers->array[i].funcs;
748 if (memEQ(f->name, name, len) && f->name[len] == 0) {
749 PerlIO_debug("%.*s => %p\n", (int) len, name, (void*)f);
753 if (load && PL_subname && PL_def_layerlist
754 && PL_def_layerlist->cur >= 2) {
755 if (PL_in_load_module) {
756 Perl_croak(aTHX_ "Recursive call to Perl_load_module in PerlIO_find_layer");
759 SV *pkgsv = newSVpvn("PerlIO", 6);
760 SV *layer = newSVpvn(name, len);
761 CV *cv = get_cv("PerlIO::Layer::NoWarnings", FALSE);
763 SAVEINT(PL_in_load_module);
765 SAVEGENERICSV(PL_warnhook);
767 PL_warnhook = (SV *) cv;
771 * The two SVs are magically freed by load_module
773 Perl_load_module(aTHX_ 0, pkgsv, Nullsv, layer, Nullsv);
776 return PerlIO_find_layer(aTHX_ name, len, 0);
779 PerlIO_debug("Cannot find %.*s\n", (int) len, name);
783 #ifdef USE_ATTRIBUTES_FOR_PERLIO
786 perlio_mg_set(pTHX_ SV *sv, MAGIC *mg)
789 IO *io = GvIOn((GV *) SvRV(sv));
790 PerlIO *ifp = IoIFP(io);
791 PerlIO *ofp = IoOFP(io);
792 Perl_warn(aTHX_ "set %" SVf " %p %p %p", sv, io, ifp, ofp);
798 perlio_mg_get(pTHX_ SV *sv, MAGIC *mg)
801 IO *io = GvIOn((GV *) SvRV(sv));
802 PerlIO *ifp = IoIFP(io);
803 PerlIO *ofp = IoOFP(io);
804 Perl_warn(aTHX_ "get %" SVf " %p %p %p", sv, io, ifp, ofp);
810 perlio_mg_clear(pTHX_ SV *sv, MAGIC *mg)
812 Perl_warn(aTHX_ "clear %" SVf, sv);
817 perlio_mg_free(pTHX_ SV *sv, MAGIC *mg)
819 Perl_warn(aTHX_ "free %" SVf, sv);
823 MGVTBL perlio_vtab = {
831 XS(XS_io_MODIFY_SCALAR_ATTRIBUTES)
834 SV *sv = SvRV(ST(1));
839 sv_magic(sv, (SV *) av, PERL_MAGIC_ext, NULL, 0);
841 mg = mg_find(sv, PERL_MAGIC_ext);
842 mg->mg_virtual = &perlio_vtab;
844 Perl_warn(aTHX_ "attrib %" SVf, sv);
845 for (i = 2; i < items; i++) {
847 const char *name = SvPV(ST(i), len);
848 SV *layer = PerlIO_find_layer(aTHX_ name, len, 1);
850 av_push(av, SvREFCNT_inc(layer));
861 #endif /* USE_ATTIBUTES_FOR_PERLIO */
864 PerlIO_tab_sv(pTHX_ PerlIO_funcs *tab)
866 HV *stash = gv_stashpv("PerlIO::Layer", TRUE);
867 SV *sv = sv_bless(newRV_noinc(newSViv(PTR2IV(tab))), stash);
871 XS(XS_PerlIO__Layer__NoWarnings)
873 /* This is used as a %SIG{__WARN__} handler to supress warnings
874 during loading of layers.
878 PerlIO_debug("warning:%s\n",SvPV_nolen(ST(0)));
882 XS(XS_PerlIO__Layer__find)
886 Perl_croak(aTHX_ "Usage class->find(name[,load])");
889 const char *name = SvPV(ST(1), len);
890 const bool load = (items > 2) ? SvTRUE(ST(2)) : 0;
891 PerlIO_funcs *layer = PerlIO_find_layer(aTHX_ name, len, load);
893 (layer) ? sv_2mortal(PerlIO_tab_sv(aTHX_ layer)) :
900 PerlIO_define_layer(pTHX_ PerlIO_funcs *tab)
902 if (!PL_known_layers)
903 PL_known_layers = PerlIO_list_alloc(aTHX);
904 PerlIO_list_push(aTHX_ PL_known_layers, tab, Nullsv);
905 PerlIO_debug("define %s %p\n", tab->name, (void*)tab);
909 PerlIO_parse_layers(pTHX_ PerlIO_list_t *av, const char *names)
912 const char *s = names;
914 while (isSPACE(*s) || *s == ':')
919 const char *as = Nullch;
921 if (!isIDFIRST(*s)) {
923 * Message is consistent with how attribute lists are
924 * passed. Even though this means "foo : : bar" is
925 * seen as an invalid separator character.
927 const char q = ((*s == '\'') ? '"' : '\'');
928 if (ckWARN(WARN_LAYER))
929 Perl_warner(aTHX_ packWARN(WARN_LAYER),
930 "Invalid separator character %c%c%c in PerlIO layer specification %s",
932 SETERRNO(EINVAL, LIB_INVARG);
937 } while (isALNUM(*e));
953 * It's a nul terminated string, not allowed
954 * to \ the terminating null. Anything other
955 * character is passed over.
965 if (ckWARN(WARN_LAYER))
966 Perl_warner(aTHX_ packWARN(WARN_LAYER),
967 "Argument list not closed for PerlIO layer \"%.*s\"",
979 const bool warn_layer = ckWARN(WARN_LAYER);
980 PerlIO_funcs *layer =
981 PerlIO_find_layer(aTHX_ s, llen, 1);
983 PerlIO_list_push(aTHX_ av, layer,
990 Perl_warner(aTHX_ packWARN(WARN_LAYER), "Unknown PerlIO layer \"%.*s\"",
1003 PerlIO_default_buffer(pTHX_ PerlIO_list_t *av)
1005 PERLIO_FUNCS_DECL(*tab) = &PerlIO_perlio;
1006 #ifdef PERLIO_USING_CRLF
1009 if (PerlIO_stdio.Set_ptrcnt)
1010 tab = &PerlIO_stdio;
1012 PerlIO_debug("Pushing %s\n", tab->name);
1013 PerlIO_list_push(aTHX_ av, PerlIO_find_layer(aTHX_ tab->name, 0, 0),
1018 PerlIO_arg_fetch(PerlIO_list_t *av, IV n)
1020 return av->array[n].arg;
1024 PerlIO_layer_fetch(pTHX_ PerlIO_list_t *av, IV n, PerlIO_funcs *def)
1026 if (n >= 0 && n < av->cur) {
1027 PerlIO_debug("Layer %" IVdf " is %s\n", n,
1028 av->array[n].funcs->name);
1029 return av->array[n].funcs;
1032 Perl_croak(aTHX_ "panic: PerlIO layer array corrupt");
1037 PerlIOPop_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1042 if (PerlIOValid(f)) {
1044 PerlIO_pop(aTHX_ f);
1050 PERLIO_FUNCS_DECL(PerlIO_remove) = {
1051 sizeof(PerlIO_funcs),
1054 PERLIO_K_DUMMY | PERLIO_K_UTF8,
1074 NULL, /* get_base */
1075 NULL, /* get_bufsiz */
1078 NULL, /* set_ptrcnt */
1082 PerlIO_default_layers(pTHX)
1084 if (!PL_def_layerlist) {
1085 const char *s = (PL_tainting) ? Nullch : PerlEnv_getenv("PERLIO");
1086 PERLIO_FUNCS_DECL(*osLayer) = &PerlIO_unix;
1087 PL_def_layerlist = PerlIO_list_alloc(aTHX);
1088 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_unix));
1090 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_win32));
1092 osLayer = &PerlIO_win32;
1095 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_raw));
1096 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_perlio));
1097 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_stdio));
1098 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_crlf));
1100 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_mmap));
1102 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_utf8));
1103 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_remove));
1104 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_byte));
1105 PerlIO_list_push(aTHX_ PL_def_layerlist,
1106 PerlIO_find_layer(aTHX_ osLayer->name, 0, 0),
1109 PerlIO_parse_layers(aTHX_ PL_def_layerlist, s);
1112 PerlIO_default_buffer(aTHX_ PL_def_layerlist);
1115 if (PL_def_layerlist->cur < 2) {
1116 PerlIO_default_buffer(aTHX_ PL_def_layerlist);
1118 return PL_def_layerlist;
1122 Perl_boot_core_PerlIO(pTHX)
1124 #ifdef USE_ATTRIBUTES_FOR_PERLIO
1125 newXS("io::MODIFY_SCALAR_ATTRIBUTES", XS_io_MODIFY_SCALAR_ATTRIBUTES,
1128 newXS("PerlIO::Layer::find", XS_PerlIO__Layer__find, __FILE__);
1129 newXS("PerlIO::Layer::NoWarnings", XS_PerlIO__Layer__NoWarnings, __FILE__);
1133 PerlIO_default_layer(pTHX_ I32 n)
1135 PerlIO_list_t *av = PerlIO_default_layers(aTHX);
1138 return PerlIO_layer_fetch(aTHX_ av, n, PERLIO_FUNCS_CAST(&PerlIO_stdio));
1141 #define PerlIO_default_top() PerlIO_default_layer(aTHX_ -1)
1142 #define PerlIO_default_btm() PerlIO_default_layer(aTHX_ 0)
1145 PerlIO_stdstreams(pTHX)
1148 PerlIO_allocate(aTHX);
1149 PerlIO_fdopen(0, "Ir" PERLIO_STDTEXT);
1150 PerlIO_fdopen(1, "Iw" PERLIO_STDTEXT);
1151 PerlIO_fdopen(2, "Iw" PERLIO_STDTEXT);
1156 PerlIO_push(pTHX_ PerlIO *f, PERLIO_FUNCS_DECL(*tab), const char *mode, SV *arg)
1158 if (tab->fsize != sizeof(PerlIO_funcs)) {
1160 Perl_croak(aTHX_ "Layer does not match this perl");
1164 if (tab->size < sizeof(PerlIOl)) {
1167 /* Real layer with a data area */
1168 Newc('L',l,tab->size,char,PerlIOl);
1170 Zero(l, tab->size, char);
1172 l->tab = (PerlIO_funcs*) tab;
1174 PerlIO_debug("PerlIO_push f=%p %s %s %p\n", (void*)f, tab->name,
1175 (mode) ? mode : "(Null)", (void*)arg);
1176 if (*l->tab->Pushed &&
1177 (*l->tab->Pushed) (aTHX_ f, mode, arg, (PerlIO_funcs*) tab) != 0) {
1178 PerlIO_pop(aTHX_ f);
1184 /* Pseudo-layer where push does its own stack adjust */
1185 PerlIO_debug("PerlIO_push f=%p %s %s %p\n", (void*)f, tab->name,
1186 (mode) ? mode : "(Null)", (void*)arg);
1188 (*tab->Pushed) (aTHX_ f, mode, arg, (PerlIO_funcs*) tab) != 0) {
1196 PerlIOBase_binmode(pTHX_ PerlIO *f)
1198 if (PerlIOValid(f)) {
1199 /* Is layer suitable for raw stream ? */
1200 if (PerlIOBase(f)->tab->kind & PERLIO_K_RAW) {
1201 /* Yes - turn off UTF-8-ness, to undo UTF-8 locale effects */
1202 PerlIOBase(f)->flags &= ~PERLIO_F_UTF8;
1205 /* Not suitable - pop it */
1206 PerlIO_pop(aTHX_ f);
1214 PerlIORaw_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1220 if (PerlIOValid(f)) {
1225 * Strip all layers that are not suitable for a raw stream
1228 while (t && (l = *t)) {
1229 if (l->tab->Binmode) {
1230 /* Has a handler - normal case */
1231 if ((*l->tab->Binmode)(aTHX_ f) == 0) {
1233 /* Layer still there - move down a layer */
1242 /* No handler - pop it */
1243 PerlIO_pop(aTHX_ t);
1246 if (PerlIOValid(f)) {
1247 PerlIO_debug(":raw f=%p :%s\n", (void*)f, PerlIOBase(f)->tab->name);
1255 PerlIO_apply_layera(pTHX_ PerlIO *f, const char *mode,
1256 PerlIO_list_t *layers, IV n, IV max)
1260 PerlIO_funcs *tab = PerlIO_layer_fetch(aTHX_ layers, n, NULL);
1262 if (!PerlIO_push(aTHX_ f, tab, mode, PerlIOArg)) {
1273 PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode, const char *names)
1277 PerlIO_list_t *layers = PerlIO_list_alloc(aTHX);
1278 code = PerlIO_parse_layers(aTHX_ layers, names);
1280 code = PerlIO_apply_layera(aTHX_ f, mode, layers, 0, layers->cur);
1282 PerlIO_list_free(aTHX_ layers);
1288 /*--------------------------------------------------------------------------------------*/
1290 * Given the abstraction above the public API functions
1294 PerlIO_binmode(pTHX_ PerlIO *f, int iotype, int mode, const char *names)
1296 PerlIO_debug("PerlIO_binmode f=%p %s %c %x %s\n",
1297 (void*)f, PerlIOBase(f)->tab->name, iotype, mode,
1298 (names) ? names : "(Null)");
1300 /* Do not flush etc. if (e.g.) switching encodings.
1301 if a pushed layer knows it needs to flush lower layers
1302 (for example :unix which is never going to call them)
1303 it can do the flush when it is pushed.
1305 return PerlIO_apply_layers(aTHX_ f, NULL, names) == 0 ? TRUE : FALSE;
1308 /* Fake 5.6 legacy of using this call to turn ON O_TEXT */
1309 #ifdef PERLIO_USING_CRLF
1310 /* Legacy binmode only has meaning if O_TEXT has a value distinct from
1311 O_BINARY so we can look for it in mode.
1313 if (!(mode & O_BINARY)) {
1315 /* FIXME?: Looking down the layer stack seems wrong,
1316 but is a way of reaching past (say) an encoding layer
1317 to flip CRLF-ness of the layer(s) below
1320 /* Perhaps we should turn on bottom-most aware layer
1321 e.g. Ilya's idea that UNIX TTY could serve
1323 if (PerlIOBase(f)->tab->kind & PERLIO_K_CANCRLF) {
1324 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF)) {
1325 /* Not in text mode - flush any pending stuff and flip it */
1327 PerlIOBase(f)->flags |= PERLIO_F_CRLF;
1329 /* Only need to turn it on in one layer so we are done */
1334 /* Not finding a CRLF aware layer presumably means we are binary
1335 which is not what was requested - so we failed
1336 We _could_ push :crlf layer but so could caller
1341 /* Legacy binmode is now _defined_ as being equivalent to pushing :raw
1342 So code that used to be here is now in PerlIORaw_pushed().
1344 return PerlIO_push(aTHX_ f, PERLIO_FUNCS_CAST(&PerlIO_raw), Nullch, Nullsv) ? TRUE : FALSE;
1349 PerlIO__close(pTHX_ PerlIO *f)
1351 if (PerlIOValid(f)) {
1352 PerlIO_funcs *tab = PerlIOBase(f)->tab;
1353 if (tab && tab->Close)
1354 return (*tab->Close)(aTHX_ f);
1356 return PerlIOBase_close(aTHX_ f);
1359 SETERRNO(EBADF, SS_IVCHAN);
1365 Perl_PerlIO_close(pTHX_ PerlIO *f)
1367 const int code = PerlIO__close(aTHX_ f);
1368 while (PerlIOValid(f)) {
1369 PerlIO_pop(aTHX_ f);
1375 Perl_PerlIO_fileno(pTHX_ PerlIO *f)
1377 Perl_PerlIO_or_Base(f, Fileno, fileno, -1, (aTHX_ f));
1381 PerlIO_context_layers(pTHX_ const char *mode)
1383 const char *type = NULL;
1385 * Need to supply default layer info from open.pm
1388 SV *layers = PL_curcop->cop_io;
1391 type = SvPV(layers, len);
1392 if (type && mode[0] != 'r') {
1394 * Skip to write part
1396 const char *s = strchr(type, 0);
1397 if (s && (STRLEN)(s - type) < len) {
1406 static PerlIO_funcs *
1407 PerlIO_layer_from_ref(pTHX_ SV *sv)
1410 * For any scalar type load the handler which is bundled with perl
1412 if (SvTYPE(sv) < SVt_PVAV)
1413 return PerlIO_find_layer(aTHX_ "scalar", 6, 1);
1416 * For other types allow if layer is known but don't try and load it
1418 switch (SvTYPE(sv)) {
1420 return PerlIO_find_layer(aTHX_ "Array", 5, 0);
1422 return PerlIO_find_layer(aTHX_ "Hash", 4, 0);
1424 return PerlIO_find_layer(aTHX_ "Code", 4, 0);
1426 return PerlIO_find_layer(aTHX_ "Glob", 4, 0);
1432 PerlIO_resolve_layers(pTHX_ const char *layers,
1433 const char *mode, int narg, SV **args)
1435 PerlIO_list_t *def = PerlIO_default_layers(aTHX);
1438 PerlIO_stdstreams(aTHX);
1442 * If it is a reference but not an object see if we have a handler
1445 if (SvROK(arg) && !sv_isobject(arg)) {
1446 PerlIO_funcs *handler = PerlIO_layer_from_ref(aTHX_ SvRV(arg));
1448 def = PerlIO_list_alloc(aTHX);
1449 PerlIO_list_push(aTHX_ def, handler, &PL_sv_undef);
1453 * Don't fail if handler cannot be found :via(...) etc. may do
1454 * something sensible else we will just stringfy and open
1460 layers = PerlIO_context_layers(aTHX_ mode);
1461 if (layers && *layers) {
1465 av = PerlIO_list_alloc(aTHX);
1466 for (i = 0; i < def->cur; i++) {
1467 PerlIO_list_push(aTHX_ av, def->array[i].funcs,
1474 if (PerlIO_parse_layers(aTHX_ av, layers) == 0) {
1478 PerlIO_list_free(aTHX_ av);
1479 return (PerlIO_list_t *) NULL;
1490 PerlIO_openn(pTHX_ const char *layers, const char *mode, int fd,
1491 int imode, int perm, PerlIO *f, int narg, SV **args)
1493 if (!f && narg == 1 && *args == &PL_sv_undef) {
1494 if ((f = PerlIO_tmpfile())) {
1496 layers = PerlIO_context_layers(aTHX_ mode);
1497 if (layers && *layers)
1498 PerlIO_apply_layers(aTHX_ f, mode, layers);
1502 PerlIO_list_t *layera;
1504 PerlIO_funcs *tab = NULL;
1505 if (PerlIOValid(f)) {
1507 * This is "reopen" - it is not tested as perl does not use it
1511 layera = PerlIO_list_alloc(aTHX);
1513 SV *arg = (l->tab->Getarg)
1514 ? (*l->tab->Getarg) (aTHX_ &l, NULL, 0)
1516 PerlIO_list_push(aTHX_ layera, l->tab, arg);
1517 l = *PerlIONext(&l);
1521 layera = PerlIO_resolve_layers(aTHX_ layers, mode, narg, args);
1527 * Start at "top" of layer stack
1529 n = layera->cur - 1;
1531 PerlIO_funcs *t = PerlIO_layer_fetch(aTHX_ layera, n, NULL);
1540 * Found that layer 'n' can do opens - call it
1542 if (narg > 1 && !(tab->kind & PERLIO_K_MULTIARG)) {
1543 Perl_croak(aTHX_ "More than one argument to open(,':%s')",tab->name);
1545 PerlIO_debug("openn(%s,'%s','%s',%d,%x,%o,%p,%d,%p)\n",
1546 tab->name, layers, mode, fd, imode, perm,
1547 (void*)f, narg, (void*)args);
1549 f = (*tab->Open) (aTHX_ tab, layera, n, mode, fd, imode, perm,
1552 SETERRNO(EINVAL, LIB_INVARG);
1556 if (n + 1 < layera->cur) {
1558 * More layers above the one that we used to open -
1561 if (PerlIO_apply_layera(aTHX_ f, mode, layera, n + 1, layera->cur) != 0) {
1562 /* If pushing layers fails close the file */
1569 PerlIO_list_free(aTHX_ layera);
1576 Perl_PerlIO_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
1578 Perl_PerlIO_or_Base(f, Read, read, -1, (aTHX_ f, vbuf, count));
1582 Perl_PerlIO_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
1584 Perl_PerlIO_or_Base(f, Unread, unread, -1, (aTHX_ f, vbuf, count));
1588 Perl_PerlIO_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
1590 Perl_PerlIO_or_fail(f, Write, -1, (aTHX_ f, vbuf, count));
1594 Perl_PerlIO_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
1596 Perl_PerlIO_or_fail(f, Seek, -1, (aTHX_ f, offset, whence));
1600 Perl_PerlIO_tell(pTHX_ PerlIO *f)
1602 Perl_PerlIO_or_fail(f, Tell, -1, (aTHX_ f));
1606 Perl_PerlIO_flush(pTHX_ PerlIO *f)
1610 const PerlIO_funcs *tab = PerlIOBase(f)->tab;
1612 if (tab && tab->Flush)
1613 return (*tab->Flush) (aTHX_ f);
1615 return 0; /* If no Flush defined, silently succeed. */
1618 PerlIO_debug("Cannot flush f=%p\n", (void*)f);
1619 SETERRNO(EBADF, SS_IVCHAN);
1625 * Is it good API design to do flush-all on NULL, a potentially
1626 * errorneous input? Maybe some magical value (PerlIO*
1627 * PERLIO_FLUSH_ALL = (PerlIO*)-1;)? Yes, stdio does similar
1628 * things on fflush(NULL), but should we be bound by their design
1631 PerlIO **table = &PL_perlio;
1633 while ((f = *table)) {
1635 table = (PerlIO **) (f++);
1636 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
1637 if (*f && PerlIO_flush(f) != 0)
1647 PerlIOBase_flush_linebuf(pTHX)
1649 PerlIO **table = &PL_perlio;
1651 while ((f = *table)) {
1653 table = (PerlIO **) (f++);
1654 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
1657 flags & (PERLIO_F_LINEBUF | PERLIO_F_CANWRITE))
1658 == (PERLIO_F_LINEBUF | PERLIO_F_CANWRITE))
1666 Perl_PerlIO_fill(pTHX_ PerlIO *f)
1668 Perl_PerlIO_or_fail(f, Fill, -1, (aTHX_ f));
1672 PerlIO_isutf8(PerlIO *f)
1675 return (PerlIOBase(f)->flags & PERLIO_F_UTF8) != 0;
1677 SETERRNO(EBADF, SS_IVCHAN);
1683 Perl_PerlIO_eof(pTHX_ PerlIO *f)
1685 Perl_PerlIO_or_Base(f, Eof, eof, -1, (aTHX_ f));
1689 Perl_PerlIO_error(pTHX_ PerlIO *f)
1691 Perl_PerlIO_or_Base(f, Error, error, -1, (aTHX_ f));
1695 Perl_PerlIO_clearerr(pTHX_ PerlIO *f)
1697 Perl_PerlIO_or_Base_void(f, Clearerr, clearerr, (aTHX_ f));
1701 Perl_PerlIO_setlinebuf(pTHX_ PerlIO *f)
1703 Perl_PerlIO_or_Base_void(f, Setlinebuf, setlinebuf, (aTHX_ f));
1707 PerlIO_has_base(PerlIO *f)
1709 if (PerlIOValid(f)) {
1710 const PerlIO_funcs *tab = PerlIOBase(f)->tab;
1713 return (tab->Get_base != NULL);
1714 SETERRNO(EINVAL, LIB_INVARG);
1717 SETERRNO(EBADF, SS_IVCHAN);
1723 PerlIO_fast_gets(PerlIO *f)
1725 if (PerlIOValid(f) && (PerlIOBase(f)->flags & PERLIO_F_FASTGETS)) {
1726 const PerlIO_funcs *tab = PerlIOBase(f)->tab;
1729 return (tab->Set_ptrcnt != NULL);
1730 SETERRNO(EINVAL, LIB_INVARG);
1733 SETERRNO(EBADF, SS_IVCHAN);
1739 PerlIO_has_cntptr(PerlIO *f)
1741 if (PerlIOValid(f)) {
1742 const PerlIO_funcs *tab = PerlIOBase(f)->tab;
1745 return (tab->Get_ptr != NULL && tab->Get_cnt != NULL);
1746 SETERRNO(EINVAL, LIB_INVARG);
1749 SETERRNO(EBADF, SS_IVCHAN);
1755 PerlIO_canset_cnt(PerlIO *f)
1757 if (PerlIOValid(f)) {
1758 const PerlIO_funcs *tab = PerlIOBase(f)->tab;
1761 return (tab->Set_ptrcnt != NULL);
1762 SETERRNO(EINVAL, LIB_INVARG);
1765 SETERRNO(EBADF, SS_IVCHAN);
1771 Perl_PerlIO_get_base(pTHX_ PerlIO *f)
1773 Perl_PerlIO_or_fail(f, Get_base, NULL, (aTHX_ f));
1777 Perl_PerlIO_get_bufsiz(pTHX_ PerlIO *f)
1779 Perl_PerlIO_or_fail(f, Get_bufsiz, -1, (aTHX_ f));
1783 Perl_PerlIO_get_ptr(pTHX_ PerlIO *f)
1785 Perl_PerlIO_or_fail(f, Get_ptr, NULL, (aTHX_ f));
1789 Perl_PerlIO_get_cnt(pTHX_ PerlIO *f)
1791 Perl_PerlIO_or_fail(f, Get_cnt, -1, (aTHX_ f));
1795 Perl_PerlIO_set_cnt(pTHX_ PerlIO *f, int cnt)
1797 Perl_PerlIO_or_fail_void(f, Set_ptrcnt, (aTHX_ f, NULL, cnt));
1801 Perl_PerlIO_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, int cnt)
1803 Perl_PerlIO_or_fail_void(f, Set_ptrcnt, (aTHX_ f, ptr, cnt));
1807 /*--------------------------------------------------------------------------------------*/
1809 * utf8 and raw dummy layers
1813 PerlIOUtf8_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1817 if (PerlIOValid(f)) {
1818 if (tab->kind & PERLIO_K_UTF8)
1819 PerlIOBase(f)->flags |= PERLIO_F_UTF8;
1821 PerlIOBase(f)->flags &= ~PERLIO_F_UTF8;
1827 PERLIO_FUNCS_DECL(PerlIO_utf8) = {
1828 sizeof(PerlIO_funcs),
1831 PERLIO_K_DUMMY | PERLIO_K_UTF8,
1851 NULL, /* get_base */
1852 NULL, /* get_bufsiz */
1855 NULL, /* set_ptrcnt */
1858 PERLIO_FUNCS_DECL(PerlIO_byte) = {
1859 sizeof(PerlIO_funcs),
1882 NULL, /* get_base */
1883 NULL, /* get_bufsiz */
1886 NULL, /* set_ptrcnt */
1890 PerlIORaw_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
1891 IV n, const char *mode, int fd, int imode, int perm,
1892 PerlIO *old, int narg, SV **args)
1894 PerlIO_funcs *tab = PerlIO_default_btm();
1896 if (tab && tab->Open)
1897 return (*tab->Open) (aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
1899 SETERRNO(EINVAL, LIB_INVARG);
1903 PERLIO_FUNCS_DECL(PerlIO_raw) = {
1904 sizeof(PerlIO_funcs),
1927 NULL, /* get_base */
1928 NULL, /* get_bufsiz */
1931 NULL, /* set_ptrcnt */
1933 /*--------------------------------------------------------------------------------------*/
1934 /*--------------------------------------------------------------------------------------*/
1936 * "Methods" of the "base class"
1940 PerlIOBase_fileno(pTHX_ PerlIO *f)
1942 return PerlIOValid(f) ? PerlIO_fileno(PerlIONext(f)) : -1;
1946 PerlIO_modestr(PerlIO * f, char *buf)
1949 if (PerlIOValid(f)) {
1950 const IV flags = PerlIOBase(f)->flags;
1951 if (flags & PERLIO_F_APPEND) {
1953 if (flags & PERLIO_F_CANREAD) {
1957 else if (flags & PERLIO_F_CANREAD) {
1959 if (flags & PERLIO_F_CANWRITE)
1962 else if (flags & PERLIO_F_CANWRITE) {
1964 if (flags & PERLIO_F_CANREAD) {
1968 #ifdef PERLIO_USING_CRLF
1969 if (!(flags & PERLIO_F_CRLF))
1979 PerlIOBase_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1981 PerlIOl * const l = PerlIOBase(f);
1984 l->flags &= ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE |
1985 PERLIO_F_TRUNCATE | PERLIO_F_APPEND);
1986 if (tab->Set_ptrcnt != NULL)
1987 l->flags |= PERLIO_F_FASTGETS;
1989 if (*mode == IoTYPE_NUMERIC || *mode == IoTYPE_IMPLICIT)
1993 l->flags |= PERLIO_F_CANREAD;
1996 l->flags |= PERLIO_F_APPEND | PERLIO_F_CANWRITE;
1999 l->flags |= PERLIO_F_TRUNCATE | PERLIO_F_CANWRITE;
2002 SETERRNO(EINVAL, LIB_INVARG);
2008 l->flags |= PERLIO_F_CANREAD | PERLIO_F_CANWRITE;
2011 l->flags &= ~PERLIO_F_CRLF;
2014 l->flags |= PERLIO_F_CRLF;
2017 SETERRNO(EINVAL, LIB_INVARG);
2024 l->flags |= l->next->flags &
2025 (PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_TRUNCATE |
2030 PerlIO_debug("PerlIOBase_pushed f=%p %s %s fl=%08" UVxf " (%s)\n",
2031 f, PerlIOBase(f)->tab->name, (omode) ? omode : "(Null)",
2032 l->flags, PerlIO_modestr(f, temp));
2038 PerlIOBase_popped(pTHX_ PerlIO *f)
2045 PerlIOBase_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
2048 * Save the position as current head considers it
2050 const Off_t old = PerlIO_tell(f);
2051 PerlIO_push(aTHX_ f, PERLIO_FUNCS_CAST(&PerlIO_pending), "r", Nullsv);
2052 PerlIOSelf(f, PerlIOBuf)->posn = old;
2053 return PerlIOBuf_unread(aTHX_ f, vbuf, count);
2057 PerlIOBase_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
2059 STDCHAR *buf = (STDCHAR *) vbuf;
2061 if (!(PerlIOBase(f)->flags & PERLIO_F_CANREAD)) {
2062 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2063 SETERRNO(EBADF, SS_IVCHAN);
2067 SSize_t avail = PerlIO_get_cnt(f);
2070 take = ((SSize_t)count < avail) ? count : avail;
2072 STDCHAR *ptr = PerlIO_get_ptr(f);
2073 Copy(ptr, buf, take, STDCHAR);
2074 PerlIO_set_ptrcnt(f, ptr + take, (avail -= take));
2078 if (count > 0 && avail <= 0) {
2079 if (PerlIO_fill(f) != 0)
2083 return (buf - (STDCHAR *) vbuf);
2089 PerlIOBase_noop_ok(pTHX_ PerlIO *f)
2096 PerlIOBase_noop_fail(pTHX_ PerlIO *f)
2103 PerlIOBase_close(pTHX_ PerlIO *f)
2106 if (PerlIOValid(f)) {
2107 PerlIO *n = PerlIONext(f);
2108 code = PerlIO_flush(f);
2109 PerlIOBase(f)->flags &=
2110 ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_OPEN);
2111 while (PerlIOValid(n)) {
2112 const PerlIO_funcs * const tab = PerlIOBase(n)->tab;
2113 if (tab && tab->Close) {
2114 if ((*tab->Close)(aTHX_ n) != 0)
2119 PerlIOBase(n)->flags &=
2120 ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_OPEN);
2126 SETERRNO(EBADF, SS_IVCHAN);
2132 PerlIOBase_eof(pTHX_ PerlIO *f)
2134 if (PerlIOValid(f)) {
2135 return (PerlIOBase(f)->flags & PERLIO_F_EOF) != 0;
2141 PerlIOBase_error(pTHX_ PerlIO *f)
2143 if (PerlIOValid(f)) {
2144 return (PerlIOBase(f)->flags & PERLIO_F_ERROR) != 0;
2150 PerlIOBase_clearerr(pTHX_ PerlIO *f)
2152 if (PerlIOValid(f)) {
2153 PerlIO *n = PerlIONext(f);
2154 PerlIOBase(f)->flags &= ~(PERLIO_F_ERROR | PERLIO_F_EOF);
2161 PerlIOBase_setlinebuf(pTHX_ PerlIO *f)
2163 if (PerlIOValid(f)) {
2164 PerlIOBase(f)->flags |= PERLIO_F_LINEBUF;
2169 PerlIO_sv_dup(pTHX_ SV *arg, CLONE_PARAMS *param)
2175 return sv_dup(arg, param);
2178 return newSVsv(arg);
2181 return newSVsv(arg);
2186 PerlIOBase_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2188 PerlIO *nexto = PerlIONext(o);
2189 if (PerlIOValid(nexto)) {
2190 const PerlIO_funcs * const tab = PerlIOBase(nexto)->tab;
2191 if (tab && tab->Dup)
2192 f = (*tab->Dup)(aTHX_ f, nexto, param, flags);
2194 f = PerlIOBase_dup(aTHX_ f, nexto, param, flags);
2197 PerlIO_funcs *self = PerlIOBase(o)->tab;
2200 PerlIO_debug("PerlIOBase_dup %s f=%p o=%p param=%p\n",
2201 self->name, (void*)f, (void*)o, (void*)param);
2203 arg = (*self->Getarg)(aTHX_ o, param, flags);
2207 f = PerlIO_push(aTHX_ f, self, PerlIO_modestr(o,buf), arg);
2216 perl_mutex PerlIO_mutex;
2219 /* PL_perlio_fd_refcnt[] is in intrpvar.h */
2224 /* Place holder for stdstreams call ??? */
2226 MUTEX_INIT(&PerlIO_mutex);
2231 PerlIOUnix_refcnt_inc(int fd)
2234 if (fd >= 0 && fd < PERLIO_MAX_REFCOUNTABLE_FD) {
2236 MUTEX_LOCK(&PerlIO_mutex);
2238 PL_perlio_fd_refcnt[fd]++;
2239 PerlIO_debug("fd %d refcnt=%d\n",fd,PL_perlio_fd_refcnt[fd]);
2241 MUTEX_UNLOCK(&PerlIO_mutex);
2247 PerlIOUnix_refcnt_dec(int fd)
2251 if (fd >= 0 && fd < PERLIO_MAX_REFCOUNTABLE_FD) {
2253 MUTEX_LOCK(&PerlIO_mutex);
2255 cnt = --PL_perlio_fd_refcnt[fd];
2256 PerlIO_debug("fd %d refcnt=%d\n",fd,cnt);
2258 MUTEX_UNLOCK(&PerlIO_mutex);
2265 PerlIO_cleanup(pTHX)
2269 PerlIO_debug("Cleanup layers for %p\n",aTHX);
2271 PerlIO_debug("Cleanup layers\n");
2273 /* Raise STDIN..STDERR refcount so we don't close them */
2274 for (i=0; i < 3; i++)
2275 PerlIOUnix_refcnt_inc(i);
2276 PerlIO_cleantable(aTHX_ &PL_perlio);
2277 /* Restore STDIN..STDERR refcount */
2278 for (i=0; i < 3; i++)
2279 PerlIOUnix_refcnt_dec(i);
2281 if (PL_known_layers) {
2282 PerlIO_list_free(aTHX_ PL_known_layers);
2283 PL_known_layers = NULL;
2285 if (PL_def_layerlist) {
2286 PerlIO_list_free(aTHX_ PL_def_layerlist);
2287 PL_def_layerlist = NULL;
2293 /*--------------------------------------------------------------------------------------*/
2295 * Bottom-most level for UNIX-like case
2299 struct _PerlIO base; /* The generic part */
2300 int fd; /* UNIX like file descriptor */
2301 int oflags; /* open/fcntl flags */
2305 PerlIOUnix_oflags(const char *mode)
2308 if (*mode == IoTYPE_IMPLICIT || *mode == IoTYPE_NUMERIC)
2313 if (*++mode == '+') {
2320 oflags = O_CREAT | O_TRUNC;
2321 if (*++mode == '+') {
2330 oflags = O_CREAT | O_APPEND;
2331 if (*++mode == '+') {
2344 else if (*mode == 't') {
2346 oflags &= ~O_BINARY;
2350 * Always open in binary mode
2353 if (*mode || oflags == -1) {
2354 SETERRNO(EINVAL, LIB_INVARG);
2361 PerlIOUnix_fileno(pTHX_ PerlIO *f)
2363 return PerlIOSelf(f, PerlIOUnix)->fd;
2367 PerlIOUnix_setfd(pTHX_ PerlIO *f, int fd, int imode)
2369 PerlIOUnix * const s = PerlIOSelf(f, PerlIOUnix);
2372 if (PerlLIO_fstat(fd, &st) == 0) {
2373 if (!S_ISREG(st.st_mode)) {
2374 PerlIO_debug("%d is not regular file\n",fd);
2375 PerlIOBase(f)->flags |= PERLIO_F_NOTREG;
2378 PerlIO_debug("%d _is_ a regular file\n",fd);
2384 PerlIOUnix_refcnt_inc(fd);
2388 PerlIOUnix_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2390 IV code = PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
2391 if (*PerlIONext(f)) {
2392 /* We never call down so do any pending stuff now */
2393 PerlIO_flush(PerlIONext(f));
2395 * XXX could (or should) we retrieve the oflags from the open file
2396 * handle rather than believing the "mode" we are passed in? XXX
2397 * Should the value on NULL mode be 0 or -1?
2399 PerlIOUnix_setfd(aTHX_ f, PerlIO_fileno(PerlIONext(f)),
2400 mode ? PerlIOUnix_oflags(mode) : -1);
2402 PerlIOBase(f)->flags |= PERLIO_F_OPEN;
2408 PerlIOUnix_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
2410 const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2412 if (PerlIOBase(f)->flags & PERLIO_F_NOTREG) {
2414 SETERRNO(ESPIPE, LIB_INVARG);
2416 SETERRNO(EINVAL, LIB_INVARG);
2420 new_loc = PerlLIO_lseek(fd, offset, whence);
2421 if (new_loc == (Off_t) - 1)
2425 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
2430 PerlIOUnix_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
2431 IV n, const char *mode, int fd, int imode,
2432 int perm, PerlIO *f, int narg, SV **args)
2434 if (PerlIOValid(f)) {
2435 if (PerlIOBase(f)->flags & PERLIO_F_OPEN)
2436 (*PerlIOBase(f)->tab->Close)(aTHX_ f);
2439 if (*mode == IoTYPE_NUMERIC)
2442 imode = PerlIOUnix_oflags(mode);
2446 const char *path = SvPV_nolen(*args);
2447 fd = PerlLIO_open3(path, imode, perm);
2451 if (*mode == IoTYPE_IMPLICIT)
2454 f = PerlIO_allocate(aTHX);
2456 if (!PerlIOValid(f)) {
2457 if (!(f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg))) {
2461 PerlIOUnix_setfd(aTHX_ f, fd, imode);
2462 PerlIOBase(f)->flags |= PERLIO_F_OPEN;
2463 if (*mode == IoTYPE_APPEND)
2464 PerlIOUnix_seek(aTHX_ f, 0, SEEK_END);
2470 * FIXME: pop layers ???
2478 PerlIOUnix_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2480 PerlIOUnix *os = PerlIOSelf(o, PerlIOUnix);
2482 if (flags & PERLIO_DUP_FD) {
2483 fd = PerlLIO_dup(fd);
2485 if (fd >= 0 && fd < PERLIO_MAX_REFCOUNTABLE_FD) {
2486 f = PerlIOBase_dup(aTHX_ f, o, param, flags);
2488 /* If all went well overwrite fd in dup'ed lay with the dup()'ed fd */
2489 PerlIOUnix_setfd(aTHX_ f, fd, os->oflags);
2498 PerlIOUnix_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
2500 const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2501 #ifdef PERLIO_STD_SPECIAL
2503 return PERLIO_STD_IN(fd, vbuf, count);
2505 if (!(PerlIOBase(f)->flags & PERLIO_F_CANREAD) ||
2506 PerlIOBase(f)->flags & (PERLIO_F_EOF|PERLIO_F_ERROR)) {
2510 SSize_t len = PerlLIO_read(fd, vbuf, count);
2511 if (len >= 0 || errno != EINTR) {
2513 if (errno != EAGAIN) {
2514 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2517 else if (len == 0 && count != 0) {
2518 PerlIOBase(f)->flags |= PERLIO_F_EOF;
2528 PerlIOUnix_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
2530 const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2531 #ifdef PERLIO_STD_SPECIAL
2532 if (fd == 1 || fd == 2)
2533 return PERLIO_STD_OUT(fd, vbuf, count);
2536 const SSize_t len = PerlLIO_write(fd, vbuf, count);
2537 if (len >= 0 || errno != EINTR) {
2539 if (errno != EAGAIN) {
2540 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2550 PerlIOUnix_tell(pTHX_ PerlIO *f)
2552 return PerlLIO_lseek(PerlIOSelf(f, PerlIOUnix)->fd, 0, SEEK_CUR);
2557 PerlIOUnix_close(pTHX_ PerlIO *f)
2559 const int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2561 if (PerlIOBase(f)->flags & PERLIO_F_OPEN) {
2562 if (PerlIOUnix_refcnt_dec(fd) > 0) {
2563 PerlIOBase(f)->flags &= ~PERLIO_F_OPEN;
2568 SETERRNO(EBADF,SS_IVCHAN);
2571 while (PerlLIO_close(fd) != 0) {
2572 if (errno != EINTR) {
2579 PerlIOBase(f)->flags &= ~PERLIO_F_OPEN;
2584 PERLIO_FUNCS_DECL(PerlIO_unix) = {
2585 sizeof(PerlIO_funcs),
2592 PerlIOBase_binmode, /* binmode */
2602 PerlIOBase_noop_ok, /* flush */
2603 PerlIOBase_noop_fail, /* fill */
2606 PerlIOBase_clearerr,
2607 PerlIOBase_setlinebuf,
2608 NULL, /* get_base */
2609 NULL, /* get_bufsiz */
2612 NULL, /* set_ptrcnt */
2615 /*--------------------------------------------------------------------------------------*/
2620 #if defined(VMS) && !defined(STDIO_BUFFER_WRITABLE)
2621 /* perl5.8 - This ensures the last minute VMS ungetc fix is not
2622 broken by the last second glibc 2.3 fix
2624 #define STDIO_BUFFER_WRITABLE
2629 struct _PerlIO base;
2630 FILE *stdio; /* The stream */
2634 PerlIOStdio_fileno(pTHX_ PerlIO *f)
2637 if (PerlIOValid(f) && (s = PerlIOSelf(f, PerlIOStdio)->stdio)) {
2638 return PerlSIO_fileno(s);
2645 PerlIOStdio_mode(const char *mode, char *tmode)
2647 char * const ret = tmode;
2653 #if defined(PERLIO_USING_CRLF) || defined(__CYGWIN__)
2661 PerlIOStdio_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2664 if (PerlIOValid(f) && PerlIOValid(n = PerlIONext(f))) {
2665 PerlIO_funcs *toptab = PerlIOBase(n)->tab;
2666 if (toptab == tab) {
2667 /* Top is already stdio - pop self (duplicate) and use original */
2668 PerlIO_pop(aTHX_ f);
2671 const int fd = PerlIO_fileno(n);
2674 if (fd >= 0 && (stdio = PerlSIO_fdopen(fd,
2675 mode = PerlIOStdio_mode(mode, tmode)))) {
2676 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2677 /* We never call down so do any pending stuff now */
2678 PerlIO_flush(PerlIONext(f));
2685 return PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
2690 PerlIO_importFILE(FILE *stdio, const char *mode)
2696 if (!mode || !*mode) {
2697 /* We need to probe to see how we can open the stream
2698 so start with read/write and then try write and read
2699 we dup() so that we can fclose without loosing the fd.
2701 Note that the errno value set by a failing fdopen
2702 varies between stdio implementations.
2704 const int fd = PerlLIO_dup(fileno(stdio));
2705 FILE *f2 = PerlSIO_fdopen(fd, (mode = "r+"));
2707 f2 = PerlSIO_fdopen(fd, (mode = "w"));
2710 f2 = PerlSIO_fdopen(fd, (mode = "r"));
2713 /* Don't seem to be able to open */
2719 if ((f = PerlIO_push(aTHX_(f = PerlIO_allocate(aTHX)), PERLIO_FUNCS_CAST(&PerlIO_stdio), mode, Nullsv))) {
2720 s = PerlIOSelf(f, PerlIOStdio);
2728 PerlIOStdio_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
2729 IV n, const char *mode, int fd, int imode,
2730 int perm, PerlIO *f, int narg, SV **args)
2733 if (PerlIOValid(f)) {
2734 const char *path = SvPV_nolen(*args);
2735 PerlIOStdio *s = PerlIOSelf(f, PerlIOStdio);
2737 PerlIOUnix_refcnt_dec(fileno(s->stdio));
2738 stdio = PerlSIO_freopen(path, (mode = PerlIOStdio_mode(mode, tmode)),
2743 PerlIOUnix_refcnt_inc(fileno(s->stdio));
2748 const char *path = SvPV_nolen(*args);
2749 if (*mode == IoTYPE_NUMERIC) {
2751 fd = PerlLIO_open3(path, imode, perm);
2755 bool appended = FALSE;
2757 /* Cygwin wants its 'b' early. */
2759 mode = PerlIOStdio_mode(mode, tmode);
2761 stdio = PerlSIO_fopen(path, mode);
2765 f = PerlIO_allocate(aTHX);
2768 mode = PerlIOStdio_mode(mode, tmode);
2769 f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg);
2771 s = PerlIOSelf(f, PerlIOStdio);
2773 PerlIOUnix_refcnt_inc(fileno(s->stdio));
2785 if (*mode == IoTYPE_IMPLICIT) {
2792 stdio = PerlSIO_stdin;
2795 stdio = PerlSIO_stdout;
2798 stdio = PerlSIO_stderr;
2803 stdio = PerlSIO_fdopen(fd, mode =
2804 PerlIOStdio_mode(mode, tmode));
2808 f = PerlIO_allocate(aTHX);
2810 if ((f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg))) {
2811 PerlIOStdio *s = PerlIOSelf(f, PerlIOStdio);
2813 PerlIOUnix_refcnt_inc(fileno(s->stdio));
2823 PerlIOStdio_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2825 /* This assumes no layers underneath - which is what
2826 happens, but is not how I remember it. NI-S 2001/10/16
2828 if ((f = PerlIOBase_dup(aTHX_ f, o, param, flags))) {
2829 FILE *stdio = PerlIOSelf(o, PerlIOStdio)->stdio;
2830 const int fd = fileno(stdio);
2832 if (flags & PERLIO_DUP_FD) {
2833 const int dfd = PerlLIO_dup(fileno(stdio));
2835 stdio = PerlSIO_fdopen(dfd, PerlIO_modestr(o,mode));
2839 /* FIXME: To avoid messy error recovery if dup fails
2840 re-use the existing stdio as though flag was not set
2844 stdio = PerlSIO_fdopen(fd, PerlIO_modestr(o,mode));
2846 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2847 PerlIOUnix_refcnt_inc(fileno(stdio));
2853 PerlIOStdio_invalidate_fileno(pTHX_ FILE *f)
2855 /* XXX this could use PerlIO_canset_fileno() and
2856 * PerlIO_set_fileno() support from Configure
2858 # if defined(__UCLIBC__)
2859 /* uClibc must come before glibc because it defines __GLIBC__ as well. */
2862 # elif defined(__GLIBC__)
2863 /* There may be a better way for GLIBC:
2864 - libio.h defines a flag to not close() on cleanup
2868 # elif defined(__sun__)
2870 /* On solaris, if _LP64 is defined, the FILE structure is this:
2876 * It turns out that the fd is stored in the top 32 bits of
2877 * file->__pad[4]. The lower 32 bits contain flags. file->pad[5] appears
2878 * to contain a pointer or offset into another structure. All the
2879 * remaining fields are zero.
2881 * We set the top bits to -1 (0xFFFFFFFF).
2883 f->__pad[4] |= 0xffffffff00000000L;
2884 assert(fileno(f) == 0xffffffff);
2885 # else /* !defined(_LP64) */
2886 /* _file is just a unsigned char :-(
2887 Not clear why we dup() rather than using -1
2888 even if that would be treated as 0xFF - so will
2891 f->_file = PerlLIO_dup(fileno(f));
2892 # endif /* defined(_LP64) */
2894 # elif defined(__hpux)
2898 /* Next one ->_file seems to be a reasonable fallback, i.e. if
2899 your platform does not have special entry try this one.
2900 [For OSF only have confirmation for Tru64 (alpha)
2901 but assume other OSFs will be similar.]
2903 # elif defined(_AIX) || defined(__osf__) || defined(__irix__)
2906 # elif defined(__FreeBSD__)
2907 /* There may be a better way on FreeBSD:
2908 - we could insert a dummy func in the _close function entry
2909 f->_close = (int (*)(void *)) dummy_close;
2913 # elif defined(__OpenBSD__)
2914 /* There may be a better way on OpenBSD:
2915 - we could insert a dummy func in the _close function entry
2916 f->_close = (int (*)(void *)) dummy_close;
2920 # elif defined(__EMX__)
2921 /* f->_flags &= ~_IOOPEN; */ /* Will leak stream->_buffer */
2924 # elif defined(__CYGWIN__)
2925 /* There may be a better way on CYGWIN:
2926 - we could insert a dummy func in the _close function entry
2927 f->_close = (int (*)(void *)) dummy_close;
2931 # elif defined(WIN32)
2932 # if defined(__BORLANDC__)
2933 f->fd = PerlLIO_dup(fileno(f));
2934 # elif defined(UNDER_CE)
2935 /* WIN_CE does not have access to FILE internals, it hardly has FILE
2944 /* Sarathy's code did this - we fall back to a dup/dup2 hack
2945 (which isn't thread safe) instead
2947 # error "Don't know how to set FILE.fileno on your platform"
2954 PerlIOStdio_close(pTHX_ PerlIO *f)
2956 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
2962 const int fd = fileno(stdio);
2968 #ifdef SOCKS5_VERSION_NAME
2969 /* Socks lib overrides close() but stdio isn't linked to
2970 that library (though we are) - so we must call close()
2971 on sockets on stdio's behalf.
2974 Sock_size_t optlen = sizeof(int);
2975 if (getsockopt(fd, SOL_SOCKET, SO_TYPE, (void *) &optval, &optlen) == 0) {
2980 if (PerlIOUnix_refcnt_dec(fd) > 0) {
2981 /* File descriptor still in use */
2986 /* For STD* handles don't close the stdio at all
2987 this is because we have shared the FILE * too
2989 if (stdio == stdin) {
2990 /* Some stdios are buggy fflush-ing inputs */
2993 else if (stdio == stdout || stdio == stderr) {
2994 return PerlIO_flush(f);
2996 /* Tricky - must fclose(stdio) to free memory but not close(fd)
2997 Use Sarathy's trick from maint-5.6 to invalidate the
2998 fileno slot of the FILE *
3000 result = PerlIO_flush(f);
3002 if (!(invalidate = PerlIOStdio_invalidate_fileno(aTHX_ stdio))) {
3003 dupfd = PerlLIO_dup(fd);
3006 result = PerlSIO_fclose(stdio);
3007 /* We treat error from stdio as success if we invalidated
3008 errno may NOT be expected EBADF
3010 if (invalidate && result != 0) {
3015 /* in SOCKS case let close() determine return value */
3019 PerlLIO_dup2(dupfd,fd);
3020 PerlLIO_close(dupfd);
3027 PerlIOStdio_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
3029 FILE *s = PerlIOSelf(f, PerlIOStdio)->stdio;
3033 STDCHAR *buf = (STDCHAR *) vbuf;
3035 * Perl is expecting PerlIO_getc() to fill the buffer Linux's
3036 * stdio does not do that for fread()
3038 const int ch = PerlSIO_fgetc(s);
3045 got = PerlSIO_fread(vbuf, 1, count, s);
3046 if (got == 0 && PerlSIO_ferror(s))
3048 if (got >= 0 || errno != EINTR)
3051 SETERRNO(0,0); /* just in case */
3057 PerlIOStdio_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3060 FILE *s = PerlIOSelf(f, PerlIOStdio)->stdio;
3062 #ifdef STDIO_BUFFER_WRITABLE
3063 if (PerlIO_fast_gets(f) && PerlIO_has_base(f)) {
3064 STDCHAR *buf = ((STDCHAR *) vbuf) + count;
3065 STDCHAR *base = PerlIO_get_base(f);
3066 SSize_t cnt = PerlIO_get_cnt(f);
3067 STDCHAR *ptr = PerlIO_get_ptr(f);
3068 SSize_t avail = ptr - base;
3070 if (avail > count) {
3074 Move(buf-avail,ptr,avail,STDCHAR);
3077 PerlIO_set_ptrcnt(f,ptr,cnt+avail);
3078 if (PerlSIO_feof(s) && unread >= 0)
3079 PerlSIO_clearerr(s);
3084 if (PerlIO_has_cntptr(f)) {
3085 /* We can get pointer to buffer but not its base
3086 Do ungetc() but check chars are ending up in the
3089 STDCHAR *eptr = (STDCHAR*)PerlSIO_get_ptr(s);
3090 STDCHAR *buf = ((STDCHAR *) vbuf) + count;
3092 const int ch = *--buf & 0xFF;
3093 if (ungetc(ch,s) != ch) {
3094 /* ungetc did not work */
3097 if ((STDCHAR*)PerlSIO_get_ptr(s) != --eptr || ((*eptr & 0xFF) != ch)) {
3098 /* Did not change pointer as expected */
3099 fgetc(s); /* get char back again */
3109 unread += PerlIOBase_unread(aTHX_ f, vbuf, count);
3115 PerlIOStdio_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3119 got = PerlSIO_fwrite(vbuf, 1, count,
3120 PerlIOSelf(f, PerlIOStdio)->stdio);
3121 if (got >= 0 || errno != EINTR)
3124 SETERRNO(0,0); /* just in case */
3130 PerlIOStdio_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3132 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3133 return PerlSIO_fseek(stdio, offset, whence);
3137 PerlIOStdio_tell(pTHX_ PerlIO *f)
3139 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3140 return PerlSIO_ftell(stdio);
3144 PerlIOStdio_flush(pTHX_ PerlIO *f)
3146 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3147 if (PerlIOBase(f)->flags & PERLIO_F_CANWRITE) {
3148 return PerlSIO_fflush(stdio);
3153 * FIXME: This discards ungetc() and pre-read stuff which is not
3154 * right if this is just a "sync" from a layer above Suspect right
3155 * design is to do _this_ but not have layer above flush this
3156 * layer read-to-read
3159 * Not writeable - sync by attempting a seek
3162 if (PerlSIO_fseek(stdio, (Off_t) 0, SEEK_CUR) != 0)
3170 PerlIOStdio_eof(pTHX_ PerlIO *f)
3172 return PerlSIO_feof(PerlIOSelf(f, PerlIOStdio)->stdio);
3176 PerlIOStdio_error(pTHX_ PerlIO *f)
3178 return PerlSIO_ferror(PerlIOSelf(f, PerlIOStdio)->stdio);
3182 PerlIOStdio_clearerr(pTHX_ PerlIO *f)
3184 PerlSIO_clearerr(PerlIOSelf(f, PerlIOStdio)->stdio);
3188 PerlIOStdio_setlinebuf(pTHX_ PerlIO *f)
3190 #ifdef HAS_SETLINEBUF
3191 PerlSIO_setlinebuf(PerlIOSelf(f, PerlIOStdio)->stdio);
3193 PerlSIO_setvbuf(PerlIOSelf(f, PerlIOStdio)->stdio, Nullch, _IOLBF, 0);
3199 PerlIOStdio_get_base(pTHX_ PerlIO *f)
3201 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3202 return (STDCHAR*)PerlSIO_get_base(stdio);
3206 PerlIOStdio_get_bufsiz(pTHX_ PerlIO *f)
3208 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3209 return PerlSIO_get_bufsiz(stdio);
3213 #ifdef USE_STDIO_PTR
3215 PerlIOStdio_get_ptr(pTHX_ PerlIO *f)
3217 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3218 return (STDCHAR*)PerlSIO_get_ptr(stdio);
3222 PerlIOStdio_get_cnt(pTHX_ PerlIO *f)
3224 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3225 return PerlSIO_get_cnt(stdio);
3229 PerlIOStdio_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
3231 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3233 #ifdef STDIO_PTR_LVALUE
3234 PerlSIO_set_ptr(stdio, (void*)ptr); /* LHS STDCHAR* cast non-portable */
3235 #ifdef STDIO_PTR_LVAL_SETS_CNT
3236 if (PerlSIO_get_cnt(stdio) != (cnt)) {
3237 assert(PerlSIO_get_cnt(stdio) == (cnt));
3240 #if (!defined(STDIO_PTR_LVAL_NOCHANGE_CNT))
3242 * Setting ptr _does_ change cnt - we are done
3246 #else /* STDIO_PTR_LVALUE */
3248 #endif /* STDIO_PTR_LVALUE */
3251 * Now (or only) set cnt
3253 #ifdef STDIO_CNT_LVALUE
3254 PerlSIO_set_cnt(stdio, cnt);
3255 #else /* STDIO_CNT_LVALUE */
3256 #if (defined(STDIO_PTR_LVALUE) && defined(STDIO_PTR_LVAL_SETS_CNT))
3257 PerlSIO_set_ptr(stdio,
3258 PerlSIO_get_ptr(stdio) + (PerlSIO_get_cnt(stdio) -
3260 #else /* STDIO_PTR_LVAL_SETS_CNT */
3262 #endif /* STDIO_PTR_LVAL_SETS_CNT */
3263 #endif /* STDIO_CNT_LVALUE */
3270 PerlIOStdio_fill(pTHX_ PerlIO *f)
3272 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3275 * fflush()ing read-only streams can cause trouble on some stdio-s
3277 if ((PerlIOBase(f)->flags & PERLIO_F_CANWRITE)) {
3278 if (PerlSIO_fflush(stdio) != 0)
3281 c = PerlSIO_fgetc(stdio);
3285 #if (defined(STDIO_PTR_LVALUE) && (defined(STDIO_CNT_LVALUE) || defined(STDIO_PTR_LVAL_SETS_CNT)))
3287 #ifdef STDIO_BUFFER_WRITABLE
3288 if (PerlIO_fast_gets(f) && PerlIO_has_base(f)) {
3289 /* Fake ungetc() to the real buffer in case system's ungetc
3292 STDCHAR *base = (STDCHAR*)PerlSIO_get_base(stdio);
3293 SSize_t cnt = PerlSIO_get_cnt(stdio);
3294 STDCHAR *ptr = (STDCHAR*)PerlSIO_get_ptr(stdio);
3295 if (ptr == base+1) {
3296 *--ptr = (STDCHAR) c;
3297 PerlIOStdio_set_ptrcnt(aTHX_ f,ptr,cnt+1);
3298 if (PerlSIO_feof(stdio))
3299 PerlSIO_clearerr(stdio);
3305 if (PerlIO_has_cntptr(f)) {
3307 if (PerlIOStdio_unread(aTHX_ f,&ch,1) == 1) {
3314 /* An ungetc()d char is handled separately from the regular
3315 * buffer, so we stuff it in the buffer ourselves.
3316 * Should never get called as should hit code above
3318 *(--((*stdio)->_ptr)) = (unsigned char) c;
3321 /* If buffer snoop scheme above fails fall back to
3324 if (PerlSIO_ungetc(c, stdio) != c)
3332 PERLIO_FUNCS_DECL(PerlIO_stdio) = {
3333 sizeof(PerlIO_funcs),
3335 sizeof(PerlIOStdio),
3336 PERLIO_K_BUFFERED|PERLIO_K_RAW,
3340 PerlIOBase_binmode, /* binmode */
3354 PerlIOStdio_clearerr,
3355 PerlIOStdio_setlinebuf,
3357 PerlIOStdio_get_base,
3358 PerlIOStdio_get_bufsiz,
3363 #ifdef USE_STDIO_PTR
3364 PerlIOStdio_get_ptr,
3365 PerlIOStdio_get_cnt,
3366 # if defined(HAS_FAST_STDIO) && defined(USE_FAST_STDIO)
3367 PerlIOStdio_set_ptrcnt,
3370 # endif /* HAS_FAST_STDIO && USE_FAST_STDIO */
3375 #endif /* USE_STDIO_PTR */
3378 /* Note that calls to PerlIO_exportFILE() are reversed using
3379 * PerlIO_releaseFILE(), not importFILE. */
3381 PerlIO_exportFILE(PerlIO * f, const char *mode)
3385 if (PerlIOValid(f)) {
3388 if (!mode || !*mode) {
3389 mode = PerlIO_modestr(f, buf);
3391 stdio = PerlSIO_fdopen(PerlIO_fileno(f), mode);
3395 /* De-link any lower layers so new :stdio sticks */
3397 if ((f2 = PerlIO_push(aTHX_ f, PERLIO_FUNCS_CAST(&PerlIO_stdio), buf, Nullsv))) {
3398 PerlIOStdio *s = PerlIOSelf((f = f2), PerlIOStdio);
3400 /* Link previous lower layers under new one */
3404 /* restore layers list */
3414 PerlIO_findFILE(PerlIO *f)
3418 if (l->tab == &PerlIO_stdio) {
3419 PerlIOStdio *s = PerlIOSelf(&l, PerlIOStdio);
3422 l = *PerlIONext(&l);
3424 /* Uses fallback "mode" via PerlIO_modestr() in PerlIO_exportFILE */
3425 return PerlIO_exportFILE(f, Nullch);
3428 /* Use this to reverse PerlIO_exportFILE calls. */
3430 PerlIO_releaseFILE(PerlIO *p, FILE *f)
3435 if (l->tab == &PerlIO_stdio) {
3436 PerlIOStdio *s = PerlIOSelf(&l, PerlIOStdio);
3437 if (s->stdio == f) {
3439 PerlIO_pop(aTHX_ p);
3448 /*--------------------------------------------------------------------------------------*/
3450 * perlio buffer layer
3454 PerlIOBuf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
3456 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3457 const int fd = PerlIO_fileno(f);
3458 if (fd >= 0 && PerlLIO_isatty(fd)) {
3459 PerlIOBase(f)->flags |= PERLIO_F_LINEBUF | PERLIO_F_TTY;
3461 if (*PerlIONext(f)) {
3462 const Off_t posn = PerlIO_tell(PerlIONext(f));
3463 if (posn != (Off_t) - 1) {
3467 return PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
3471 PerlIOBuf_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
3472 IV n, const char *mode, int fd, int imode, int perm,
3473 PerlIO *f, int narg, SV **args)
3475 if (PerlIOValid(f)) {
3476 PerlIO *next = PerlIONext(f);
3478 PerlIO_layer_fetch(aTHX_ layers, n - 1, PerlIOBase(next)->tab);
3479 if (tab && tab->Open)
3481 (*tab->Open)(aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
3483 if (!next || (*PerlIOBase(f)->tab->Pushed) (aTHX_ f, mode, PerlIOArg, self) != 0) {
3488 PerlIO_funcs *tab = PerlIO_layer_fetch(aTHX_ layers, n - 1, PerlIO_default_btm());
3490 if (*mode == IoTYPE_IMPLICIT) {
3496 if (tab && tab->Open)
3497 f = (*tab->Open)(aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
3500 SETERRNO(EINVAL, LIB_INVARG);
3502 if (PerlIO_push(aTHX_ f, self, mode, PerlIOArg) == 0) {
3504 * if push fails during open, open fails. close will pop us.
3509 fd = PerlIO_fileno(f);
3510 if (init && fd == 2) {
3512 * Initial stderr is unbuffered
3514 PerlIOBase(f)->flags |= PERLIO_F_UNBUF;
3516 #ifdef PERLIO_USING_CRLF
3517 # ifdef PERLIO_IS_BINMODE_FD
3518 if (PERLIO_IS_BINMODE_FD(fd))
3519 PerlIO_binmode(aTHX_ f, '<'/*not used*/, O_BINARY, Nullch);
3523 * do something about failing setmode()? --jhi
3525 PerlLIO_setmode(fd, O_BINARY);
3534 * This "flush" is akin to sfio's sync in that it handles files in either
3535 * read or write state
3538 PerlIOBuf_flush(pTHX_ PerlIO *f)
3540 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3542 PerlIO *n = PerlIONext(f);
3543 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF) {
3545 * write() the buffer
3547 const STDCHAR *buf = b->buf;
3548 const STDCHAR *p = buf;
3549 while (p < b->ptr) {
3550 SSize_t count = PerlIO_write(n, p, b->ptr - p);
3554 else if (count < 0 || PerlIO_error(n)) {
3555 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
3560 b->posn += (p - buf);
3562 else if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3563 STDCHAR *buf = PerlIO_get_base(f);
3565 * Note position change
3567 b->posn += (b->ptr - buf);
3568 if (b->ptr < b->end) {
3569 /* We did not consume all of it - try and seek downstream to
3570 our logical position
3572 if (PerlIOValid(n) && PerlIO_seek(n, b->posn, SEEK_SET) == 0) {
3573 /* Reload n as some layers may pop themselves on seek */
3574 b->posn = PerlIO_tell(n = PerlIONext(f));
3577 /* Seek failed (e.g. pipe or tty). Do NOT clear buffer or pre-read
3578 data is lost for good - so return saying "ok" having undone
3581 b->posn -= (b->ptr - buf);
3586 b->ptr = b->end = b->buf;
3587 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3588 /* We check for Valid because of dubious decision to make PerlIO_flush(NULL) flush all */
3589 if (PerlIOValid(n) && PerlIO_flush(n) != 0)
3595 PerlIOBuf_fill(pTHX_ PerlIO *f)
3597 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3598 PerlIO *n = PerlIONext(f);
3601 * Down-stream flush is defined not to loose read data so is harmless.
3602 * we would not normally be fill'ing if there was data left in anycase.
3604 if (PerlIO_flush(f) != 0)
3606 if (PerlIOBase(f)->flags & PERLIO_F_TTY)
3607 PerlIOBase_flush_linebuf(aTHX);
3610 PerlIO_get_base(f); /* allocate via vtable */
3612 b->ptr = b->end = b->buf;
3614 if (!PerlIOValid(n)) {
3615 PerlIOBase(f)->flags |= PERLIO_F_EOF;
3619 if (PerlIO_fast_gets(n)) {
3621 * Layer below is also buffered. We do _NOT_ want to call its
3622 * ->Read() because that will loop till it gets what we asked for
3623 * which may hang on a pipe etc. Instead take anything it has to
3624 * hand, or ask it to fill _once_.
3626 avail = PerlIO_get_cnt(n);
3628 avail = PerlIO_fill(n);
3630 avail = PerlIO_get_cnt(n);
3632 if (!PerlIO_error(n) && PerlIO_eof(n))
3637 STDCHAR *ptr = PerlIO_get_ptr(n);
3638 SSize_t cnt = avail;
3639 if (avail > (SSize_t)b->bufsiz)
3641 Copy(ptr, b->buf, avail, STDCHAR);
3642 PerlIO_set_ptrcnt(n, ptr + avail, cnt - avail);
3646 avail = PerlIO_read(n, b->ptr, b->bufsiz);
3650 PerlIOBase(f)->flags |= PERLIO_F_EOF;
3652 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
3655 b->end = b->buf + avail;
3656 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3661 PerlIOBuf_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
3663 if (PerlIOValid(f)) {
3664 const PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3667 return PerlIOBase_read(aTHX_ f, vbuf, count);
3673 PerlIOBuf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3675 const STDCHAR *buf = (const STDCHAR *) vbuf + count;
3676 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3679 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
3684 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3686 * Buffer is already a read buffer, we can overwrite any chars
3687 * which have been read back to buffer start
3689 avail = (b->ptr - b->buf);
3693 * Buffer is idle, set it up so whole buffer is available for
3697 b->end = b->buf + avail;
3699 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3701 * Buffer extends _back_ from where we are now
3703 b->posn -= b->bufsiz;
3705 if (avail > (SSize_t) count) {
3707 * If we have space for more than count, just move count
3715 * In simple stdio-like ungetc() case chars will be already
3718 if (buf != b->ptr) {
3719 Copy(buf, b->ptr, avail, STDCHAR);
3723 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
3727 unread += PerlIOBase_unread(aTHX_ f, vbuf, count);
3733 PerlIOBuf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3735 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3736 const STDCHAR *buf = (const STDCHAR *) vbuf;
3737 const STDCHAR *flushptr = buf;
3741 if (!(PerlIOBase(f)->flags & PERLIO_F_CANWRITE))
3743 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3744 if (PerlIO_flush(f) != 0) {
3748 if (PerlIOBase(f)->flags & PERLIO_F_LINEBUF) {
3749 flushptr = buf + count;
3750 while (flushptr > buf && *(flushptr - 1) != '\n')
3754 SSize_t avail = b->bufsiz - (b->ptr - b->buf);
3755 if ((SSize_t) count < avail)
3757 if (flushptr > buf && flushptr <= buf + avail)
3758 avail = flushptr - buf;
3759 PerlIOBase(f)->flags |= PERLIO_F_WRBUF;
3761 Copy(buf, b->ptr, avail, STDCHAR);
3766 if (buf == flushptr)
3769 if (b->ptr >= (b->buf + b->bufsiz))
3772 if (PerlIOBase(f)->flags & PERLIO_F_UNBUF)
3778 PerlIOBuf_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3781 if ((code = PerlIO_flush(f)) == 0) {
3782 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
3783 code = PerlIO_seek(PerlIONext(f), offset, whence);
3785 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3786 b->posn = PerlIO_tell(PerlIONext(f));
3793 PerlIOBuf_tell(pTHX_ PerlIO *f)
3795 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3797 * b->posn is file position where b->buf was read, or will be written
3799 Off_t posn = b->posn;
3800 if ((PerlIOBase(f)->flags & PERLIO_F_APPEND) &&
3801 (PerlIOBase(f)->flags & PERLIO_F_WRBUF)) {
3803 /* As O_APPEND files are normally shared in some sense it is better
3808 /* when file is NOT shared then this is sufficient */
3809 PerlIO_seek(PerlIONext(f),0, SEEK_END);
3811 posn = b->posn = PerlIO_tell(PerlIONext(f));
3815 * If buffer is valid adjust position by amount in buffer
3817 posn += (b->ptr - b->buf);
3823 PerlIOBuf_popped(pTHX_ PerlIO *f)
3825 const IV code = PerlIOBase_popped(aTHX_ f);
3826 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3827 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
3831 b->ptr = b->end = b->buf;
3832 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3837 PerlIOBuf_close(pTHX_ PerlIO *f)
3839 const IV code = PerlIOBase_close(aTHX_ f);
3840 PerlIOBuf * const b = PerlIOSelf(f, PerlIOBuf);
3841 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
3845 b->ptr = b->end = b->buf;
3846 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3851 PerlIOBuf_get_ptr(pTHX_ PerlIO *f)
3853 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3860 PerlIOBuf_get_cnt(pTHX_ PerlIO *f)
3862 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3865 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF)
3866 return (b->end - b->ptr);
3871 PerlIOBuf_get_base(pTHX_ PerlIO *f)
3873 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3877 b->buf = Newz('B',b->buf,b->bufsiz, STDCHAR);
3879 b->buf = (STDCHAR *) & b->oneword;
3880 b->bufsiz = sizeof(b->oneword);
3889 PerlIOBuf_bufsiz(pTHX_ PerlIO *f)
3891 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3894 return (b->end - b->buf);
3898 PerlIOBuf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
3900 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3904 if (PerlIO_get_cnt(f) != cnt || b->ptr < b->buf) {
3905 assert(PerlIO_get_cnt(f) == cnt);
3906 assert(b->ptr >= b->buf);
3908 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3912 PerlIOBuf_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
3914 return PerlIOBase_dup(aTHX_ f, o, param, flags);
3919 PERLIO_FUNCS_DECL(PerlIO_perlio) = {
3920 sizeof(PerlIO_funcs),
3923 PERLIO_K_BUFFERED|PERLIO_K_RAW,
3927 PerlIOBase_binmode, /* binmode */
3941 PerlIOBase_clearerr,
3942 PerlIOBase_setlinebuf,
3947 PerlIOBuf_set_ptrcnt,
3950 /*--------------------------------------------------------------------------------------*/
3952 * Temp layer to hold unread chars when cannot do it any other way
3956 PerlIOPending_fill(pTHX_ PerlIO *f)
3959 * Should never happen
3966 PerlIOPending_close(pTHX_ PerlIO *f)
3969 * A tad tricky - flush pops us, then we close new top
3972 return PerlIO_close(f);
3976 PerlIOPending_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3979 * A tad tricky - flush pops us, then we seek new top
3982 return PerlIO_seek(f, offset, whence);
3987 PerlIOPending_flush(pTHX_ PerlIO *f)
3989 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3990 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
3994 PerlIO_pop(aTHX_ f);
3999 PerlIOPending_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
4005 PerlIOBuf_set_ptrcnt(aTHX_ f, ptr, cnt);
4010 PerlIOPending_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
4012 const IV code = PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
4013 PerlIOl *l = PerlIOBase(f);
4015 * Our PerlIO_fast_gets must match what we are pushed on, or sv_gets()
4016 * etc. get muddled when it changes mid-string when we auto-pop.
4018 l->flags = (l->flags & ~(PERLIO_F_FASTGETS | PERLIO_F_UTF8)) |
4019 (PerlIOBase(PerlIONext(f))->
4020 flags & (PERLIO_F_FASTGETS | PERLIO_F_UTF8));
4025 PerlIOPending_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
4027 SSize_t avail = PerlIO_get_cnt(f);
4029 if ((SSize_t)count < avail)
4032 got = PerlIOBuf_read(aTHX_ f, vbuf, avail);
4033 if (got >= 0 && got < (SSize_t)count) {
4034 const SSize_t more =
4035 PerlIO_read(f, ((STDCHAR *) vbuf) + got, count - got);
4036 if (more >= 0 || got == 0)
4042 PERLIO_FUNCS_DECL(PerlIO_pending) = {
4043 sizeof(PerlIO_funcs),
4046 PERLIO_K_BUFFERED|PERLIO_K_RAW, /* not sure about RAW here */
4047 PerlIOPending_pushed,
4050 PerlIOBase_binmode, /* binmode */
4059 PerlIOPending_close,
4060 PerlIOPending_flush,
4064 PerlIOBase_clearerr,
4065 PerlIOBase_setlinebuf,
4070 PerlIOPending_set_ptrcnt,
4075 /*--------------------------------------------------------------------------------------*/
4077 * crlf - translation On read translate CR,LF to "\n" we do this by
4078 * overriding ptr/cnt entries to hand back a line at a time and keeping a
4079 * record of which nl we "lied" about. On write translate "\n" to CR,LF
4083 PerlIOBuf base; /* PerlIOBuf stuff */
4084 STDCHAR *nl; /* Position of crlf we "lied" about in the
4089 PerlIOCrlf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
4092 PerlIOBase(f)->flags |= PERLIO_F_CRLF;
4093 code = PerlIOBuf_pushed(aTHX_ f, mode, arg, tab);
4095 PerlIO_debug("PerlIOCrlf_pushed f=%p %s %s fl=%08" UVxf "\n",
4096 f, PerlIOBase(f)->tab->name, (mode) ? mode : "(Null)",
4097 PerlIOBase(f)->flags);
4100 /* Enable the first CRLF capable layer you can find, but if none
4101 * found, the one we just pushed is fine. This results in at
4102 * any given moment at most one CRLF-capable layer being enabled
4103 * in the whole layer stack. */
4104 PerlIO *g = PerlIONext(f);
4106 PerlIOl *b = PerlIOBase(g);
4107 if (b && b->tab == &PerlIO_crlf) {
4108 if (!(b->flags & PERLIO_F_CRLF))
4109 b->flags |= PERLIO_F_CRLF;
4110 PerlIO_pop(aTHX_ f);
4121 PerlIOCrlf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4123 PerlIOCrlf *c = PerlIOSelf(f, PerlIOCrlf);
4128 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF))
4129 return PerlIOBuf_unread(aTHX_ f, vbuf, count);
4131 const STDCHAR *buf = (const STDCHAR *) vbuf + count;
4132 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4134 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
4139 if (!(PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4140 b->end = b->ptr = b->buf + b->bufsiz;
4141 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4142 b->posn -= b->bufsiz;
4144 while (count > 0 && b->ptr > b->buf) {
4147 if (b->ptr - 2 >= b->buf) {
4170 PerlIOCrlf_get_cnt(pTHX_ PerlIO *f)
4172 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4175 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
4176 PerlIOCrlf *c = PerlIOSelf(f, PerlIOCrlf);
4177 if ((PerlIOBase(f)->flags & PERLIO_F_CRLF) && (!c->nl || *c->nl == 0xd)) {
4178 STDCHAR *nl = (c->nl) ? c->nl : b->ptr;
4180 while (nl < b->end && *nl != 0xd)
4182 if (nl < b->end && *nl == 0xd) {
4184 if (nl + 1 < b->end) {
4191 * Not CR,LF but just CR
4199 * Blast - found CR as last char in buffer
4204 * They may not care, defer work as long as
4208 return (nl - b->ptr);
4212 b->ptr++; /* say we have read it as far as
4213 * flush() is concerned */
4214 b->buf++; /* Leave space in front of buffer */
4215 /* Note as we have moved buf up flush's
4217 will naturally make posn point at CR
4219 b->bufsiz--; /* Buffer is thus smaller */
4220 code = PerlIO_fill(f); /* Fetch some more */
4221 b->bufsiz++; /* Restore size for next time */
4222 b->buf--; /* Point at space */
4223 b->ptr = nl = b->buf; /* Which is what we hand
4225 *nl = 0xd; /* Fill in the CR */
4227 goto test; /* fill() call worked */
4229 * CR at EOF - just fall through
4231 /* Should we clear EOF though ??? */
4236 return (((c->nl) ? (c->nl + 1) : b->end) - b->ptr);
4242 PerlIOCrlf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
4244 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4245 PerlIOCrlf *c = PerlIOSelf(f, PerlIOCrlf);
4251 if (ptr == b->end && *c->nl == 0xd) {
4252 /* Defered CR at end of buffer case - we lied about count */
4264 * Test code - delete when it works ...
4266 IV flags = PerlIOBase(f)->flags;
4267 STDCHAR *chk = (c->nl) ? (c->nl+1) : b->end;
4268 if (ptr+cnt == c->nl && c->nl+1 == b->end && *c->nl == 0xd) {
4269 /* Defered CR at end of buffer case - we lied about count */
4275 Perl_croak(aTHX_ "ptr wrong %p != %p fl=%08" UVxf
4276 " nl=%p e=%p for %d", ptr, chk, flags, c->nl,
4284 * They have taken what we lied about
4292 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4296 PerlIOCrlf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4298 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF))
4299 return PerlIOBuf_write(aTHX_ f, vbuf, count);
4301 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4302 const STDCHAR *buf = (const STDCHAR *) vbuf;
4303 const STDCHAR *ebuf = buf + count;
4306 if (!(PerlIOBase(f)->flags & PERLIO_F_CANWRITE))
4308 while (buf < ebuf) {
4309 STDCHAR *eptr = b->buf + b->bufsiz;
4310 PerlIOBase(f)->flags |= PERLIO_F_WRBUF;
4311 while (buf < ebuf && b->ptr < eptr) {
4313 if ((b->ptr + 2) > eptr) {
4321 *(b->ptr)++ = 0xd; /* CR */
4322 *(b->ptr)++ = 0xa; /* LF */
4324 if (PerlIOBase(f)->flags & PERLIO_F_LINEBUF) {
4334 if (b->ptr >= eptr) {
4340 if (PerlIOBase(f)->flags & PERLIO_F_UNBUF)
4342 return (buf - (STDCHAR *) vbuf);
4347 PerlIOCrlf_flush(pTHX_ PerlIO *f)
4349 PerlIOCrlf *c = PerlIOSelf(f, PerlIOCrlf);
4354 return PerlIOBuf_flush(aTHX_ f);
4358 PerlIOCrlf_binmode(pTHX_ PerlIO *f)
4360 if ((PerlIOBase(f)->flags & PERLIO_F_CRLF)) {
4361 /* In text mode - flush any pending stuff and flip it */
4362 PerlIOBase(f)->flags &= ~PERLIO_F_CRLF;
4363 #ifndef PERLIO_USING_CRLF
4364 /* CRLF is unusual case - if this is just the :crlf layer pop it */
4365 if (PerlIOBase(f)->tab == &PerlIO_crlf) {
4366 PerlIO_pop(aTHX_ f);
4373 PERLIO_FUNCS_DECL(PerlIO_crlf) = {
4374 sizeof(PerlIO_funcs),
4377 PERLIO_K_BUFFERED | PERLIO_K_CANCRLF | PERLIO_K_RAW,
4379 PerlIOBuf_popped, /* popped */
4381 PerlIOCrlf_binmode, /* binmode */
4385 PerlIOBuf_read, /* generic read works with ptr/cnt lies */
4386 PerlIOCrlf_unread, /* Put CR,LF in buffer for each '\n' */
4387 PerlIOCrlf_write, /* Put CR,LF in buffer for each '\n' */
4395 PerlIOBase_clearerr,
4396 PerlIOBase_setlinebuf,
4401 PerlIOCrlf_set_ptrcnt,
4405 /*--------------------------------------------------------------------------------------*/
4407 * mmap as "buffer" layer
4411 PerlIOBuf base; /* PerlIOBuf stuff */
4412 Mmap_t mptr; /* Mapped address */
4413 Size_t len; /* mapped length */
4414 STDCHAR *bbuf; /* malloced buffer if map fails */
4418 PerlIOMmap_map(pTHX_ PerlIO *f)
4421 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4422 const IV flags = PerlIOBase(f)->flags;
4426 if (flags & PERLIO_F_CANREAD) {
4427 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4428 const int fd = PerlIO_fileno(f);
4430 code = Fstat(fd, &st);
4431 if (code == 0 && S_ISREG(st.st_mode)) {
4432 SSize_t len = st.st_size - b->posn;
4435 if (PL_mmap_page_size <= 0)
4436 Perl_croak(aTHX_ "panic: bad pagesize %" IVdf,
4440 * This is a hack - should never happen - open should
4443 b->posn = PerlIO_tell(PerlIONext(f));
4445 posn = (b->posn / PL_mmap_page_size) * PL_mmap_page_size;
4446 len = st.st_size - posn;
4447 m->mptr = mmap(NULL, len, PROT_READ, MAP_SHARED, fd, posn);
4448 if (m->mptr && m->mptr != (Mmap_t) - 1) {
4449 #if 0 && defined(HAS_MADVISE) && defined(MADV_SEQUENTIAL)
4450 madvise(m->mptr, len, MADV_SEQUENTIAL);
4452 #if 0 && defined(HAS_MADVISE) && defined(MADV_WILLNEED)
4453 madvise(m->mptr, len, MADV_WILLNEED);
4455 PerlIOBase(f)->flags =
4456 (flags & ~PERLIO_F_EOF) | PERLIO_F_RDBUF;
4457 b->end = ((STDCHAR *) m->mptr) + len;
4458 b->buf = ((STDCHAR *) m->mptr) + (b->posn - posn);
4467 PerlIOBase(f)->flags =
4468 flags | PERLIO_F_EOF | PERLIO_F_RDBUF;
4470 b->ptr = b->end = b->ptr;
4479 PerlIOMmap_unmap(pTHX_ PerlIO *f)
4481 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4482 PerlIOBuf *b = &m->base;
4486 code = munmap(m->mptr, m->len);
4490 if (PerlIO_seek(PerlIONext(f), b->posn, SEEK_SET) != 0)
4493 b->ptr = b->end = b->buf;
4494 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
4500 PerlIOMmap_get_base(pTHX_ PerlIO *f)
4502 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4503 PerlIOBuf *b = &m->base;
4504 if (b->buf && (PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4506 * Already have a readbuffer in progress
4512 * We have a write buffer or flushed PerlIOBuf read buffer
4514 m->bbuf = b->buf; /* save it in case we need it again */
4515 b->buf = NULL; /* Clear to trigger below */
4518 PerlIOMmap_map(aTHX_ f); /* Try and map it */
4521 * Map did not work - recover PerlIOBuf buffer if we have one
4526 b->ptr = b->end = b->buf;
4529 return PerlIOBuf_get_base(aTHX_ f);
4533 PerlIOMmap_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4535 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4536 PerlIOBuf *b = &m->base;
4537 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
4539 if (b->ptr && (b->ptr - count) >= b->buf
4540 && memEQ(b->ptr - count, vbuf, count)) {
4542 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
4547 * Loose the unwritable mapped buffer
4551 * If flush took the "buffer" see if we have one from before
4553 if (!b->buf && m->bbuf)
4556 PerlIOBuf_get_base(aTHX_ f);
4560 return PerlIOBuf_unread(aTHX_ f, vbuf, count);
4564 PerlIOMmap_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4566 PerlIOMmap * const m = PerlIOSelf(f, PerlIOMmap);
4567 PerlIOBuf * const b = &m->base;
4569 if (!b->buf || !(PerlIOBase(f)->flags & PERLIO_F_WRBUF)) {
4571 * No, or wrong sort of, buffer
4574 if (PerlIOMmap_unmap(aTHX_ f) != 0)
4578 * If unmap took the "buffer" see if we have one from before
4580 if (!b->buf && m->bbuf)
4583 PerlIOBuf_get_base(aTHX_ f);
4587 return PerlIOBuf_write(aTHX_ f, vbuf, count);
4591 PerlIOMmap_flush(pTHX_ PerlIO *f)
4593 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4594 PerlIOBuf *b = &m->base;
4595 IV code = PerlIOBuf_flush(aTHX_ f);
4597 * Now we are "synced" at PerlIOBuf level
4604 if (PerlIOMmap_unmap(aTHX_ f) != 0)
4609 * We seem to have a PerlIOBuf buffer which was not mapped
4610 * remember it in case we need one later
4619 PerlIOMmap_fill(pTHX_ PerlIO *f)
4621 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4622 IV code = PerlIO_flush(f);
4623 if (code == 0 && !b->buf) {
4624 code = PerlIOMmap_map(aTHX_ f);
4626 if (code == 0 && !(PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4627 code = PerlIOBuf_fill(aTHX_ f);
4633 PerlIOMmap_close(pTHX_ PerlIO *f)
4635 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4636 PerlIOBuf *b = &m->base;
4637 IV code = PerlIO_flush(f);
4641 b->ptr = b->end = b->buf;
4643 if (PerlIOBuf_close(aTHX_ f) != 0)
4649 PerlIOMmap_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
4651 return PerlIOBase_dup(aTHX_ f, o, param, flags);
4655 PERLIO_FUNCS_DECL(PerlIO_mmap) = {
4656 sizeof(PerlIO_funcs),
4659 PERLIO_K_BUFFERED|PERLIO_K_RAW,
4663 PerlIOBase_binmode, /* binmode */
4677 PerlIOBase_clearerr,
4678 PerlIOBase_setlinebuf,
4679 PerlIOMmap_get_base,
4683 PerlIOBuf_set_ptrcnt,
4686 #endif /* HAS_MMAP */
4689 Perl_PerlIO_stdin(pTHX)
4692 PerlIO_stdstreams(aTHX);
4694 return &PL_perlio[1];
4698 Perl_PerlIO_stdout(pTHX)
4701 PerlIO_stdstreams(aTHX);
4703 return &PL_perlio[2];
4707 Perl_PerlIO_stderr(pTHX)
4710 PerlIO_stdstreams(aTHX);
4712 return &PL_perlio[3];
4715 /*--------------------------------------------------------------------------------------*/
4718 PerlIO_getname(PerlIO *f, char *buf)
4723 bool exported = FALSE;
4724 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
4726 stdio = PerlIO_exportFILE(f,0);
4730 name = fgetname(stdio, buf);
4731 if (exported) PerlIO_releaseFILE(f,stdio);
4737 Perl_croak(aTHX_ "Don't know how to get file name");
4743 /*--------------------------------------------------------------------------------------*/
4745 * Functions which can be called on any kind of PerlIO implemented in
4749 #undef PerlIO_fdopen
4751 PerlIO_fdopen(int fd, const char *mode)
4754 return PerlIO_openn(aTHX_ Nullch, mode, fd, 0, 0, NULL, 0, NULL);
4759 PerlIO_open(const char *path, const char *mode)
4762 SV *name = sv_2mortal(newSVpvn(path, strlen(path)));
4763 return PerlIO_openn(aTHX_ Nullch, mode, -1, 0, 0, NULL, 1, &name);
4766 #undef Perlio_reopen
4768 PerlIO_reopen(const char *path, const char *mode, PerlIO *f)
4771 SV *name = sv_2mortal(newSVpvn(path, strlen(path)));
4772 return PerlIO_openn(aTHX_ Nullch, mode, -1, 0, 0, f, 1, &name);
4777 PerlIO_getc(PerlIO *f)
4781 if ( 1 == PerlIO_read(f, buf, 1) ) {
4782 return (unsigned char) buf[0];
4787 #undef PerlIO_ungetc
4789 PerlIO_ungetc(PerlIO *f, int ch)
4794 if (PerlIO_unread(f, &buf, 1) == 1)
4802 PerlIO_putc(PerlIO *f, int ch)
4806 return PerlIO_write(f, &buf, 1);
4811 PerlIO_puts(PerlIO *f, const char *s)
4814 STRLEN len = strlen(s);
4815 return PerlIO_write(f, s, len);
4818 #undef PerlIO_rewind
4820 PerlIO_rewind(PerlIO *f)
4823 PerlIO_seek(f, (Off_t) 0, SEEK_SET);
4827 #undef PerlIO_vprintf
4829 PerlIO_vprintf(PerlIO *f, const char *fmt, va_list ap)
4832 SV *sv = newSVpvn("", 0);
4838 Perl_va_copy(ap, apc);
4839 sv_vcatpvf(sv, fmt, &apc);
4841 sv_vcatpvf(sv, fmt, &ap);
4844 wrote = PerlIO_write(f, s, len);
4849 #undef PerlIO_printf
4851 PerlIO_printf(PerlIO *f, const char *fmt, ...)
4856 result = PerlIO_vprintf(f, fmt, ap);
4861 #undef PerlIO_stdoutf
4863 PerlIO_stdoutf(const char *fmt, ...)
4869 result = PerlIO_vprintf(PerlIO_stdout(), fmt, ap);
4874 #undef PerlIO_tmpfile
4876 PerlIO_tmpfile(void)
4881 const int fd = win32_tmpfd();
4883 f = PerlIO_fdopen(fd, "w+b");
4885 # if defined(HAS_MKSTEMP) && ! defined(VMS) && ! defined(OS2)
4886 SV *sv = newSVpv("/tmp/PerlIO_XXXXXX", 0);
4888 * I have no idea how portable mkstemp() is ... NI-S
4890 const int fd = mkstemp(SvPVX(sv));
4892 f = PerlIO_fdopen(fd, "w+");
4894 PerlIOBase(f)->flags |= PERLIO_F_TEMP;
4895 PerlLIO_unlink(SvPVX(sv));
4898 # else /* !HAS_MKSTEMP, fallback to stdio tmpfile(). */
4899 FILE *stdio = PerlSIO_tmpfile();
4902 if ((f = PerlIO_push(aTHX_(PerlIO_allocate(aTHX)),
4903 PERLIO_FUNCS_CAST(&PerlIO_stdio),
4905 PerlIOStdio *s = PerlIOSelf(f, PerlIOStdio);
4911 # endif /* else HAS_MKSTEMP */
4912 #endif /* else WIN32 */
4919 #endif /* USE_SFIO */
4920 #endif /* PERLIO_IS_STDIO */
4922 /*======================================================================================*/
4924 * Now some functions in terms of above which may be needed even if we are
4925 * not in true PerlIO mode
4929 #undef PerlIO_setpos
4931 PerlIO_setpos(PerlIO *f, SV *pos)
4936 Off_t *posn = (Off_t *) SvPV(pos, len);
4937 if (f && len == sizeof(Off_t))
4938 return PerlIO_seek(f, *posn, SEEK_SET);
4940 SETERRNO(EINVAL, SS_IVCHAN);
4944 #undef PerlIO_setpos
4946 PerlIO_setpos(PerlIO *f, SV *pos)
4951 Fpos_t *fpos = (Fpos_t *) SvPV(pos, len);
4952 if (f && len == sizeof(Fpos_t)) {
4953 #if defined(USE_64_BIT_STDIO) && defined(USE_FSETPOS64)
4954 return fsetpos64(f, fpos);
4956 return fsetpos(f, fpos);
4960 SETERRNO(EINVAL, SS_IVCHAN);
4966 #undef PerlIO_getpos
4968 PerlIO_getpos(PerlIO *f, SV *pos)
4971 Off_t posn = PerlIO_tell(f);
4972 sv_setpvn(pos, (char *) &posn, sizeof(posn));
4973 return (posn == (Off_t) - 1) ? -1 : 0;
4976 #undef PerlIO_getpos
4978 PerlIO_getpos(PerlIO *f, SV *pos)
4983 #if defined(USE_64_BIT_STDIO) && defined(USE_FSETPOS64)
4984 code = fgetpos64(f, &fpos);
4986 code = fgetpos(f, &fpos);
4988 sv_setpvn(pos, (char *) &fpos, sizeof(fpos));
4993 #if (defined(PERLIO_IS_STDIO) || !defined(USE_SFIO)) && !defined(HAS_VPRINTF)
4996 vprintf(char *pat, char *args)
4998 _doprnt(pat, args, stdout);
4999 return 0; /* wrong, but perl doesn't use the return
5004 vfprintf(FILE *fd, char *pat, char *args)
5006 _doprnt(pat, args, fd);
5007 return 0; /* wrong, but perl doesn't use the return
5013 #ifndef PerlIO_vsprintf
5015 PerlIO_vsprintf(char *s, int n, const char *fmt, va_list ap)
5018 const int val = vsprintf(s, fmt, ap);
5020 if (strlen(s) >= (STRLEN) n) {
5022 (void) PerlIO_puts(Perl_error_log,
5023 "panic: sprintf overflow - memory corrupted!\n");
5031 #ifndef PerlIO_sprintf
5033 PerlIO_sprintf(char *s, int n, const char *fmt, ...)
5038 result = PerlIO_vsprintf(s, n, fmt, ap);
5046 * c-indentation-style: bsd
5048 * indent-tabs-mode: t
5051 * vim: shiftwidth=4: