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 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 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 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 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)
116 perlsio_binmode(FILE *fp, int iotype, int mode)
119 * This used to be contents of do_binmode in doio.c
122 # if defined(atarist) || defined(__MINT__)
125 ((FILE *) fp)->_flag |= _IOBIN;
127 ((FILE *) fp)->_flag &= ~_IOBIN;
134 if (PerlLIO_setmode(fp, mode) != -1) {
136 if (PerlLIO_setmode(fileno(fp), mode) != -1) {
138 # if defined(WIN32) && defined(__BORLANDC__)
140 * The translation mode of the stream is maintained independent of
141 * the translation mode of the fd in the Borland RTL (heavy
142 * digging through their runtime sources reveal). User has to set
143 * the mode explicitly for the stream (though they don't document
144 * this anywhere). GSAR 97-5-24
150 fp->flags &= ~_F_BIN;
158 # if defined(USEMYBINMODE)
160 if (my_binmode(fp, iotype, mode) != FALSE)
171 #define O_ACCMODE 3 /* Assume traditional implementation */
175 PerlIO_intmode2str(int rawmode, char *mode, int *writing)
177 int result = rawmode & O_ACCMODE;
182 ptype = IoTYPE_RDONLY;
185 ptype = IoTYPE_WRONLY;
193 *writing = (result != O_RDONLY);
195 if (result == O_RDONLY) {
199 else if (rawmode & O_APPEND) {
201 if (result != O_WRONLY)
206 if (result == O_WRONLY)
213 if (rawmode & O_BINARY)
219 #ifndef PERLIO_LAYERS
221 PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode, const char *names)
223 if (!names || !*names
224 || strEQ(names, ":crlf")
225 || strEQ(names, ":raw")
226 || strEQ(names, ":bytes")
230 Perl_croak(aTHX_ "Cannot apply \"%s\" in non-PerlIO perl", names);
238 PerlIO_destruct(pTHX)
243 PerlIO_binmode(pTHX_ PerlIO *fp, int iotype, int mode, const char *names)
248 return perlsio_binmode(fp, iotype, mode);
253 PerlIO_fdupopen(pTHX_ PerlIO *f, CLONE_PARAMS *param, int flags)
255 #if defined(PERL_MICRO) || defined(SYMBIAN)
258 #ifdef PERL_IMPLICIT_SYS
259 return PerlSIO_fdupopen(f);
262 return win32_fdupopen(f);
265 int fd = PerlLIO_dup(PerlIO_fileno(f));
268 int omode = fcntl(fd, F_GETFL);
270 omode = djgpp_get_stream_mode(f);
272 PerlIO_intmode2str(omode,mode,NULL);
273 /* the r+ is a hack */
274 return PerlIO_fdopen(fd, mode);
279 SETERRNO(EBADF, SS_IVCHAN);
289 * De-mux PerlIO_openn() into fdopen, freopen and fopen type entries
293 PerlIO_openn(pTHX_ const char *layers, const char *mode, int fd,
294 int imode, int perm, PerlIO *old, int narg, SV **args)
298 Perl_croak(aTHX_ "More than one argument to open");
300 if (*args == &PL_sv_undef)
301 return PerlIO_tmpfile();
303 char *name = SvPV_nolen(*args);
304 if (*mode == IoTYPE_NUMERIC) {
305 fd = PerlLIO_open3(name, imode, perm);
307 return PerlIO_fdopen(fd, (char *) mode + 1);
310 return PerlIO_reopen(name, mode, old);
313 return PerlIO_open(name, mode);
318 return PerlIO_fdopen(fd, (char *) mode);
323 XS(XS_PerlIO__Layer__find)
327 Perl_croak(aTHX_ "Usage class->find(name[,load])");
329 char *name = SvPV_nolen(ST(1));
330 ST(0) = (strEQ(name, "crlf")
331 || strEQ(name, "raw")) ? &PL_sv_yes : &PL_sv_undef;
338 Perl_boot_core_PerlIO(pTHX)
340 newXS("PerlIO::Layer::find", XS_PerlIO__Layer__find, __FILE__);
346 #ifdef PERLIO_IS_STDIO
352 * Does nothing (yet) except force this file to be included in perl
353 * binary. That allows this file to force inclusion of other functions
354 * that may be required by loadable extensions e.g. for
355 * FileHandle::tmpfile
359 #undef PerlIO_tmpfile
366 #else /* PERLIO_IS_STDIO */
374 * This section is just to make sure these functions get pulled in from
378 #undef PerlIO_tmpfile
389 * Force this file to be included in perl binary. Which allows this
390 * file to force inclusion of other functions that may be required by
391 * loadable extensions e.g. for FileHandle::tmpfile
395 * Hack sfio does its own 'autoflush' on stdout in common cases. Flush
396 * results in a lot of lseek()s to regular files and lot of small
399 sfset(sfstdout, SF_SHARE, 0);
402 /* This is not the reverse of PerlIO_exportFILE(), PerlIO_releaseFILE() is. */
404 PerlIO_importFILE(FILE *stdio, const char *mode)
406 int fd = fileno(stdio);
407 if (!mode || !*mode) {
410 return PerlIO_fdopen(fd, mode);
414 PerlIO_findFILE(PerlIO *pio)
416 int fd = PerlIO_fileno(pio);
417 FILE *f = fdopen(fd, "r+");
419 if (!f && errno == EINVAL)
421 if (!f && errno == EINVAL)
428 /*======================================================================================*/
430 * Implement all the PerlIO interface ourselves.
436 * We _MUST_ have <unistd.h> if we are using lseek() and may have large
443 #include <sys/mman.h>
447 * Why is this here - not in perlio.h? RMB
449 void PerlIO_debug(const char *fmt, ...)
450 __attribute__format__(__printf__, 1, 2);
453 PerlIO_debug(const char *fmt, ...)
458 if (!PL_perlio_debug_fd && !PL_tainting && PL_uid == PL_euid && PL_gid == PL_egid) {
459 char *s = PerlEnv_getenv("PERLIO_DEBUG");
461 PL_perlio_debug_fd = PerlLIO_open3(s, O_WRONLY | O_CREAT | O_APPEND, 0666);
463 PL_perlio_debug_fd = -1;
465 if (PL_perlio_debug_fd > 0) {
469 /* Use fixed buffer as sv_catpvf etc. needs SVs */
472 s = CopFILE(PL_curcop);
475 sprintf(buffer, "%.40s:%" IVdf " ", s, (IV) CopLINE(PL_curcop));
476 len = strlen(buffer);
477 vsprintf(buffer+len, fmt, ap);
478 PerlLIO_write(PL_perlio_debug_fd, buffer, strlen(buffer));
480 SV *sv = newSVpvn("", 0);
482 s = CopFILE(PL_curcop);
485 Perl_sv_catpvf(aTHX_ sv, "%s:%" IVdf " ", s,
486 (IV) CopLINE(PL_curcop));
487 Perl_sv_vcatpvf(aTHX_ sv, fmt, &ap);
490 PerlLIO_write(PL_perlio_debug_fd, s, len);
497 /*--------------------------------------------------------------------------------------*/
500 * Inner level routines
504 * Table of pointers to the PerlIO structs (malloc'ed)
506 #define PERLIO_TABLE_SIZE 64
509 PerlIO_allocate(pTHX)
512 * Find a free slot in the table, allocating new table as necessary
517 while ((f = *last)) {
519 last = (PerlIO **) (f);
520 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
526 Newz('I',f,PERLIO_TABLE_SIZE,PerlIO);
534 #undef PerlIO_fdupopen
536 PerlIO_fdupopen(pTHX_ PerlIO *f, CLONE_PARAMS *param, int flags)
538 if (PerlIOValid(f)) {
539 PerlIO_funcs *tab = PerlIOBase(f)->tab;
540 PerlIO_debug("fdupopen f=%p param=%p\n",(void*)f,(void*)param);
542 return (*tab->Dup)(aTHX_ PerlIO_allocate(aTHX), f, param, flags);
544 return PerlIOBase_dup(aTHX_ PerlIO_allocate(aTHX), f, param, flags);
548 SETERRNO(EBADF, SS_IVCHAN);
554 PerlIO_cleantable(pTHX_ PerlIO **tablep)
556 PerlIO *table = *tablep;
559 PerlIO_cleantable(aTHX_(PerlIO **) & (table[0]));
560 for (i = PERLIO_TABLE_SIZE - 1; i > 0; i--) {
561 PerlIO *f = table + i;
573 PerlIO_list_alloc(pTHX)
576 Newz('L', list, 1, PerlIO_list_t);
582 PerlIO_list_free(pTHX_ PerlIO_list_t *list)
585 if (--list->refcnt == 0) {
588 for (i = 0; i < list->cur; i++) {
589 if (list->array[i].arg)
590 SvREFCNT_dec(list->array[i].arg);
592 Safefree(list->array);
600 PerlIO_list_push(pTHX_ PerlIO_list_t *list, PerlIO_funcs *funcs, SV *arg)
603 if (list->cur >= list->len) {
606 Renew(list->array, list->len, PerlIO_pair_t);
608 New('l', list->array, list->len, PerlIO_pair_t);
610 p = &(list->array[list->cur++]);
612 if ((p->arg = arg)) {
613 (void)SvREFCNT_inc(arg);
618 PerlIO_clone_list(pTHX_ PerlIO_list_t *proto, CLONE_PARAMS *param)
620 PerlIO_list_t *list = (PerlIO_list_t *) NULL;
623 list = PerlIO_list_alloc(aTHX);
624 for (i=0; i < proto->cur; i++) {
626 if (proto->array[i].arg)
627 arg = PerlIO_sv_dup(aTHX_ proto->array[i].arg,param);
628 PerlIO_list_push(aTHX_ list, proto->array[i].funcs, arg);
635 PerlIO_clone(pTHX_ PerlInterpreter *proto, CLONE_PARAMS *param)
638 PerlIO **table = &proto->Iperlio;
641 PL_known_layers = PerlIO_clone_list(aTHX_ proto->Iknown_layers, param);
642 PL_def_layerlist = PerlIO_clone_list(aTHX_ proto->Idef_layerlist, param);
643 PerlIO_allocate(aTHX); /* root slot is never used */
644 PerlIO_debug("Clone %p from %p\n",aTHX,proto);
645 while ((f = *table)) {
647 table = (PerlIO **) (f++);
648 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
650 (void) fp_dup(f, 0, param);
659 PerlIO_destruct(pTHX)
661 PerlIO **table = &PL_perlio;
664 PerlIO_debug("Destruct %p\n",aTHX);
666 while ((f = *table)) {
668 table = (PerlIO **) (f++);
669 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
673 if (l->tab->kind & PERLIO_K_DESTRUCT) {
674 PerlIO_debug("Destruct popping %s\n", l->tab->name);
688 PerlIO_pop(pTHX_ PerlIO *f)
692 PerlIO_debug("PerlIO_pop f=%p %s\n", (void*)f, l->tab->name);
693 if (l->tab->Popped) {
695 * If popped returns non-zero do not free its layer structure
696 * it has either done so itself, or it is shared and still in
699 if ((*l->tab->Popped) (aTHX_ f) != 0)
707 /* Return as an array the stack of layers on a filehandle. Note that
708 * the stack is returned top-first in the array, and there are three
709 * times as many array elements as there are layers in the stack: the
710 * first element of a layer triplet is the name, the second one is the
711 * arguments, and the third one is the flags. */
714 PerlIO_get_layers(pTHX_ PerlIO *f)
718 if (PerlIOValid(f)) {
719 PerlIOl *l = PerlIOBase(f);
722 SV *name = l->tab && l->tab->name ?
723 newSVpv(l->tab->name, 0) : &PL_sv_undef;
724 SV *arg = l->tab && l->tab->Getarg ?
725 (*l->tab->Getarg)(aTHX_ &l, 0, 0) : &PL_sv_undef;
728 av_push(av, newSViv((IV)l->flags));
736 /*--------------------------------------------------------------------------------------*/
738 * XS Interface for perl code
742 PerlIO_find_layer(pTHX_ const char *name, STRLEN len, int load)
746 if ((SSize_t) len <= 0)
748 for (i = 0; i < PL_known_layers->cur; i++) {
749 PerlIO_funcs *f = PL_known_layers->array[i].funcs;
750 if (memEQ(f->name, name, len) && f->name[len] == 0) {
751 PerlIO_debug("%.*s => %p\n", (int) len, name, (void*)f);
755 if (load && PL_subname && PL_def_layerlist
756 && PL_def_layerlist->cur >= 2) {
757 if (PL_in_load_module) {
758 Perl_croak(aTHX_ "Recursive call to Perl_load_module in PerlIO_find_layer");
761 SV *pkgsv = newSVpvn("PerlIO", 6);
762 SV *layer = newSVpvn(name, len);
763 CV *cv = get_cv("PerlIO::Layer::NoWarnings", FALSE);
765 SAVEINT(PL_in_load_module);
767 SAVESPTR(PL_warnhook);
768 PL_warnhook = (SV *) cv;
772 * The two SVs are magically freed by load_module
774 Perl_load_module(aTHX_ 0, pkgsv, Nullsv, layer, Nullsv);
777 return PerlIO_find_layer(aTHX_ name, len, 0);
780 PerlIO_debug("Cannot find %.*s\n", (int) len, name);
784 #ifdef USE_ATTRIBUTES_FOR_PERLIO
787 perlio_mg_set(pTHX_ SV *sv, MAGIC *mg)
790 IO *io = GvIOn((GV *) SvRV(sv));
791 PerlIO *ifp = IoIFP(io);
792 PerlIO *ofp = IoOFP(io);
793 Perl_warn(aTHX_ "set %" SVf " %p %p %p", sv, io, ifp, ofp);
799 perlio_mg_get(pTHX_ SV *sv, MAGIC *mg)
802 IO *io = GvIOn((GV *) SvRV(sv));
803 PerlIO *ifp = IoIFP(io);
804 PerlIO *ofp = IoOFP(io);
805 Perl_warn(aTHX_ "get %" SVf " %p %p %p", sv, io, ifp, ofp);
811 perlio_mg_clear(pTHX_ SV *sv, MAGIC *mg)
813 Perl_warn(aTHX_ "clear %" SVf, sv);
818 perlio_mg_free(pTHX_ SV *sv, MAGIC *mg)
820 Perl_warn(aTHX_ "free %" SVf, sv);
824 MGVTBL perlio_vtab = {
832 XS(XS_io_MODIFY_SCALAR_ATTRIBUTES)
835 SV *sv = SvRV(ST(1));
840 sv_magic(sv, (SV *) av, PERL_MAGIC_ext, NULL, 0);
842 mg = mg_find(sv, PERL_MAGIC_ext);
843 mg->mg_virtual = &perlio_vtab;
845 Perl_warn(aTHX_ "attrib %" SVf, sv);
846 for (i = 2; i < items; i++) {
848 const char *name = SvPV(ST(i), len);
849 SV *layer = PerlIO_find_layer(aTHX_ name, len, 1);
851 av_push(av, SvREFCNT_inc(layer));
862 #endif /* USE_ATTIBUTES_FOR_PERLIO */
865 PerlIO_tab_sv(pTHX_ PerlIO_funcs *tab)
867 HV *stash = gv_stashpv("PerlIO::Layer", TRUE);
868 SV *sv = sv_bless(newRV_noinc(newSViv(PTR2IV(tab))), stash);
872 XS(XS_PerlIO__Layer__NoWarnings)
874 /* This is used as a %SIG{__WARN__} handler to supress warnings
875 during loading of layers.
879 PerlIO_debug("warning:%s\n",SvPV_nolen(ST(0)));
883 XS(XS_PerlIO__Layer__find)
887 Perl_croak(aTHX_ "Usage class->find(name[,load])");
890 char *name = SvPV(ST(1), len);
891 bool load = (items > 2) ? SvTRUE(ST(2)) : 0;
892 PerlIO_funcs *layer = PerlIO_find_layer(aTHX_ name, len, load);
894 (layer) ? sv_2mortal(PerlIO_tab_sv(aTHX_ layer)) :
901 PerlIO_define_layer(pTHX_ PerlIO_funcs *tab)
903 if (!PL_known_layers)
904 PL_known_layers = PerlIO_list_alloc(aTHX);
905 PerlIO_list_push(aTHX_ PL_known_layers, tab, Nullsv);
906 PerlIO_debug("define %s %p\n", tab->name, (void*)tab);
910 PerlIO_parse_layers(pTHX_ PerlIO_list_t *av, const char *names)
913 const char *s = names;
915 while (isSPACE(*s) || *s == ':')
920 const char *as = Nullch;
922 if (!isIDFIRST(*s)) {
924 * Message is consistent with how attribute lists are
925 * passed. Even though this means "foo : : bar" is
926 * seen as an invalid separator character.
928 char q = ((*s == '\'') ? '"' : '\'');
929 if (ckWARN(WARN_LAYER))
930 Perl_warner(aTHX_ packWARN(WARN_LAYER),
931 "Invalid separator character %c%c%c in PerlIO layer specification %s",
933 SETERRNO(EINVAL, LIB_INVARG);
938 } while (isALNUM(*e));
954 * It's a nul terminated string, not allowed
955 * to \ the terminating null. Anything other
956 * character is passed over.
966 if (ckWARN(WARN_LAYER))
967 Perl_warner(aTHX_ packWARN(WARN_LAYER),
968 "Argument list not closed for PerlIO layer \"%.*s\"",
980 bool warn_layer = ckWARN(WARN_LAYER);
981 PerlIO_funcs *layer =
982 PerlIO_find_layer(aTHX_ s, llen, 1);
984 PerlIO_list_push(aTHX_ av, layer,
991 Perl_warner(aTHX_ packWARN(WARN_LAYER), "Unknown PerlIO layer \"%.*s\"",
1004 PerlIO_default_buffer(pTHX_ PerlIO_list_t *av)
1006 PERLIO_FUNCS_DECL(*tab) = &PerlIO_perlio;
1007 #ifdef PERLIO_USING_CRLF
1010 if (PerlIO_stdio.Set_ptrcnt)
1011 tab = &PerlIO_stdio;
1013 PerlIO_debug("Pushing %s\n", tab->name);
1014 PerlIO_list_push(aTHX_ av, PerlIO_find_layer(aTHX_ tab->name, 0, 0),
1019 PerlIO_arg_fetch(PerlIO_list_t *av, IV n)
1021 return av->array[n].arg;
1025 PerlIO_layer_fetch(pTHX_ PerlIO_list_t *av, IV n, PerlIO_funcs *def)
1027 if (n >= 0 && n < av->cur) {
1028 PerlIO_debug("Layer %" IVdf " is %s\n", n,
1029 av->array[n].funcs->name);
1030 return av->array[n].funcs;
1033 Perl_croak(aTHX_ "panic: PerlIO layer array corrupt");
1038 PerlIOPop_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1040 if (PerlIOValid(f)) {
1042 PerlIO_pop(aTHX_ f);
1048 PERLIO_FUNCS_DECL(PerlIO_remove) = {
1049 sizeof(PerlIO_funcs),
1052 PERLIO_K_DUMMY | PERLIO_K_UTF8,
1070 NULL, /* get_base */
1071 NULL, /* get_bufsiz */
1074 NULL, /* set_ptrcnt */
1078 PerlIO_default_layers(pTHX)
1080 if (!PL_def_layerlist) {
1081 const char *s = (PL_tainting) ? Nullch : PerlEnv_getenv("PERLIO");
1082 PERLIO_FUNCS_DECL(*osLayer) = &PerlIO_unix;
1083 PL_def_layerlist = PerlIO_list_alloc(aTHX);
1084 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_unix));
1086 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_win32));
1088 osLayer = &PerlIO_win32;
1091 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_raw));
1092 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_perlio));
1093 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_stdio));
1094 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_crlf));
1096 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_mmap));
1098 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_utf8));
1099 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_remove));
1100 PerlIO_define_layer(aTHX_ PERLIO_FUNCS_CAST(&PerlIO_byte));
1101 PerlIO_list_push(aTHX_ PL_def_layerlist,
1102 PerlIO_find_layer(aTHX_ osLayer->name, 0, 0),
1105 PerlIO_parse_layers(aTHX_ PL_def_layerlist, s);
1108 PerlIO_default_buffer(aTHX_ PL_def_layerlist);
1111 if (PL_def_layerlist->cur < 2) {
1112 PerlIO_default_buffer(aTHX_ PL_def_layerlist);
1114 return PL_def_layerlist;
1118 Perl_boot_core_PerlIO(pTHX)
1120 #ifdef USE_ATTRIBUTES_FOR_PERLIO
1121 newXS("io::MODIFY_SCALAR_ATTRIBUTES", XS_io_MODIFY_SCALAR_ATTRIBUTES,
1124 newXS("PerlIO::Layer::find", XS_PerlIO__Layer__find, __FILE__);
1125 newXS("PerlIO::Layer::NoWarnings", XS_PerlIO__Layer__NoWarnings, __FILE__);
1129 PerlIO_default_layer(pTHX_ I32 n)
1131 PerlIO_list_t *av = PerlIO_default_layers(aTHX);
1134 return PerlIO_layer_fetch(aTHX_ av, n, PERLIO_FUNCS_CAST(&PerlIO_stdio));
1137 #define PerlIO_default_top() PerlIO_default_layer(aTHX_ -1)
1138 #define PerlIO_default_btm() PerlIO_default_layer(aTHX_ 0)
1141 PerlIO_stdstreams(pTHX)
1144 PerlIO_allocate(aTHX);
1145 PerlIO_fdopen(0, "Ir" PERLIO_STDTEXT);
1146 PerlIO_fdopen(1, "Iw" PERLIO_STDTEXT);
1147 PerlIO_fdopen(2, "Iw" PERLIO_STDTEXT);
1152 PerlIO_push(pTHX_ PerlIO *f, PERLIO_FUNCS_DECL(*tab), const char *mode, SV *arg)
1154 if (tab->fsize != sizeof(PerlIO_funcs)) {
1156 Perl_croak(aTHX_ "Layer does not match this perl");
1160 if (tab->size < sizeof(PerlIOl)) {
1163 /* Real layer with a data area */
1164 Newc('L',l,tab->size,char,PerlIOl);
1166 Zero(l, tab->size, char);
1168 l->tab = (PerlIO_funcs*) tab;
1170 PerlIO_debug("PerlIO_push f=%p %s %s %p\n", (void*)f, tab->name,
1171 (mode) ? mode : "(Null)", (void*)arg);
1172 if (*l->tab->Pushed &&
1173 (*l->tab->Pushed) (aTHX_ f, mode, arg, (PerlIO_funcs*) tab) != 0) {
1174 PerlIO_pop(aTHX_ f);
1180 /* Pseudo-layer where push does its own stack adjust */
1181 PerlIO_debug("PerlIO_push f=%p %s %s %p\n", (void*)f, tab->name,
1182 (mode) ? mode : "(Null)", (void*)arg);
1184 (*tab->Pushed) (aTHX_ f, mode, arg, (PerlIO_funcs*) tab) != 0) {
1192 PerlIOBase_binmode(pTHX_ PerlIO *f)
1194 if (PerlIOValid(f)) {
1195 /* Is layer suitable for raw stream ? */
1196 if (PerlIOBase(f)->tab->kind & PERLIO_K_RAW) {
1197 /* Yes - turn off UTF-8-ness, to undo UTF-8 locale effects */
1198 PerlIOBase(f)->flags &= ~PERLIO_F_UTF8;
1201 /* Not suitable - pop it */
1202 PerlIO_pop(aTHX_ f);
1210 PerlIORaw_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1213 if (PerlIOValid(f)) {
1218 * Strip all layers that are not suitable for a raw stream
1221 while (t && (l = *t)) {
1222 if (l->tab->Binmode) {
1223 /* Has a handler - normal case */
1224 if ((*l->tab->Binmode)(aTHX_ f) == 0) {
1226 /* Layer still there - move down a layer */
1235 /* No handler - pop it */
1236 PerlIO_pop(aTHX_ t);
1239 if (PerlIOValid(f)) {
1240 PerlIO_debug(":raw f=%p :%s\n", (void*)f, PerlIOBase(f)->tab->name);
1248 PerlIO_apply_layera(pTHX_ PerlIO *f, const char *mode,
1249 PerlIO_list_t *layers, IV n, IV max)
1253 PerlIO_funcs *tab = PerlIO_layer_fetch(aTHX_ layers, n, NULL);
1255 if (!PerlIO_push(aTHX_ f, tab, mode, PerlIOArg)) {
1266 PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode, const char *names)
1270 PerlIO_list_t *layers = PerlIO_list_alloc(aTHX);
1271 code = PerlIO_parse_layers(aTHX_ layers, names);
1273 code = PerlIO_apply_layera(aTHX_ f, mode, layers, 0, layers->cur);
1275 PerlIO_list_free(aTHX_ layers);
1281 /*--------------------------------------------------------------------------------------*/
1283 * Given the abstraction above the public API functions
1287 PerlIO_binmode(pTHX_ PerlIO *f, int iotype, int mode, const char *names)
1289 PerlIO_debug("PerlIO_binmode f=%p %s %c %x %s\n",
1290 (void*)f, PerlIOBase(f)->tab->name, iotype, mode,
1291 (names) ? names : "(Null)");
1293 /* Do not flush etc. if (e.g.) switching encodings.
1294 if a pushed layer knows it needs to flush lower layers
1295 (for example :unix which is never going to call them)
1296 it can do the flush when it is pushed.
1298 return PerlIO_apply_layers(aTHX_ f, NULL, names) == 0 ? TRUE : FALSE;
1301 /* Fake 5.6 legacy of using this call to turn ON O_TEXT */
1302 #ifdef PERLIO_USING_CRLF
1303 /* Legacy binmode only has meaning if O_TEXT has a value distinct from
1304 O_BINARY so we can look for it in mode.
1306 if (!(mode & O_BINARY)) {
1308 /* FIXME?: Looking down the layer stack seems wrong,
1309 but is a way of reaching past (say) an encoding layer
1310 to flip CRLF-ness of the layer(s) below
1313 /* Perhaps we should turn on bottom-most aware layer
1314 e.g. Ilya's idea that UNIX TTY could serve
1316 if (PerlIOBase(f)->tab->kind & PERLIO_K_CANCRLF) {
1317 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF)) {
1318 /* Not in text mode - flush any pending stuff and flip it */
1320 PerlIOBase(f)->flags |= PERLIO_F_CRLF;
1322 /* Only need to turn it on in one layer so we are done */
1327 /* Not finding a CRLF aware layer presumably means we are binary
1328 which is not what was requested - so we failed
1329 We _could_ push :crlf layer but so could caller
1334 /* Legacy binmode is now _defined_ as being equivalent to pushing :raw
1335 So code that used to be here is now in PerlIORaw_pushed().
1337 return PerlIO_push(aTHX_ f, PERLIO_FUNCS_CAST(&PerlIO_raw), Nullch, Nullsv) ? TRUE : FALSE;
1342 PerlIO__close(pTHX_ PerlIO *f)
1344 if (PerlIOValid(f)) {
1345 PerlIO_funcs *tab = PerlIOBase(f)->tab;
1346 if (tab && tab->Close)
1347 return (*tab->Close)(aTHX_ f);
1349 return PerlIOBase_close(aTHX_ f);
1352 SETERRNO(EBADF, SS_IVCHAN);
1358 Perl_PerlIO_close(pTHX_ PerlIO *f)
1360 int code = PerlIO__close(aTHX_ f);
1361 while (PerlIOValid(f)) {
1362 PerlIO_pop(aTHX_ f);
1368 Perl_PerlIO_fileno(pTHX_ PerlIO *f)
1370 Perl_PerlIO_or_Base(f, Fileno, fileno, -1, (aTHX_ f));
1374 PerlIO_context_layers(pTHX_ const char *mode)
1376 const char *type = NULL;
1378 * Need to supply default layer info from open.pm
1381 SV *layers = PL_curcop->cop_io;
1384 type = SvPV(layers, len);
1385 if (type && mode[0] != 'r') {
1387 * Skip to write part
1389 const char *s = strchr(type, 0);
1390 if (s && (STRLEN)(s - type) < len) {
1399 static PerlIO_funcs *
1400 PerlIO_layer_from_ref(pTHX_ SV *sv)
1403 * For any scalar type load the handler which is bundled with perl
1405 if (SvTYPE(sv) < SVt_PVAV)
1406 return PerlIO_find_layer(aTHX_ "scalar", 6, 1);
1409 * For other types allow if layer is known but don't try and load it
1411 switch (SvTYPE(sv)) {
1413 return PerlIO_find_layer(aTHX_ "Array", 5, 0);
1415 return PerlIO_find_layer(aTHX_ "Hash", 4, 0);
1417 return PerlIO_find_layer(aTHX_ "Code", 4, 0);
1419 return PerlIO_find_layer(aTHX_ "Glob", 4, 0);
1425 PerlIO_resolve_layers(pTHX_ const char *layers,
1426 const char *mode, int narg, SV **args)
1428 PerlIO_list_t *def = PerlIO_default_layers(aTHX);
1431 PerlIO_stdstreams(aTHX);
1435 * If it is a reference but not an object see if we have a handler
1438 if (SvROK(arg) && !sv_isobject(arg)) {
1439 PerlIO_funcs *handler = PerlIO_layer_from_ref(aTHX_ SvRV(arg));
1441 def = PerlIO_list_alloc(aTHX);
1442 PerlIO_list_push(aTHX_ def, handler, &PL_sv_undef);
1446 * Don't fail if handler cannot be found :via(...) etc. may do
1447 * something sensible else we will just stringfy and open
1453 layers = PerlIO_context_layers(aTHX_ mode);
1454 if (layers && *layers) {
1458 av = PerlIO_list_alloc(aTHX);
1459 for (i = 0; i < def->cur; i++) {
1460 PerlIO_list_push(aTHX_ av, def->array[i].funcs,
1467 if (PerlIO_parse_layers(aTHX_ av, layers) == 0) {
1471 PerlIO_list_free(aTHX_ av);
1472 return (PerlIO_list_t *) NULL;
1483 PerlIO_openn(pTHX_ const char *layers, const char *mode, int fd,
1484 int imode, int perm, PerlIO *f, int narg, SV **args)
1486 if (!f && narg == 1 && *args == &PL_sv_undef) {
1487 if ((f = PerlIO_tmpfile())) {
1489 layers = PerlIO_context_layers(aTHX_ mode);
1490 if (layers && *layers)
1491 PerlIO_apply_layers(aTHX_ f, mode, layers);
1495 PerlIO_list_t *layera = NULL;
1497 PerlIO_funcs *tab = NULL;
1498 if (PerlIOValid(f)) {
1500 * This is "reopen" - it is not tested as perl does not use it
1504 layera = PerlIO_list_alloc(aTHX);
1506 SV *arg = (l->tab->Getarg)
1507 ? (*l->tab->Getarg) (aTHX_ &l, NULL, 0)
1509 PerlIO_list_push(aTHX_ layera, l->tab, arg);
1510 l = *PerlIONext(&l);
1514 layera = PerlIO_resolve_layers(aTHX_ layers, mode, narg, args);
1520 * Start at "top" of layer stack
1522 n = layera->cur - 1;
1524 PerlIO_funcs *t = PerlIO_layer_fetch(aTHX_ layera, n, NULL);
1533 * Found that layer 'n' can do opens - call it
1535 if (narg > 1 && !(tab->kind & PERLIO_K_MULTIARG)) {
1536 Perl_croak(aTHX_ "More than one argument to open(,':%s')",tab->name);
1538 PerlIO_debug("openn(%s,'%s','%s',%d,%x,%o,%p,%d,%p)\n",
1539 tab->name, layers, mode, fd, imode, perm,
1540 (void*)f, narg, (void*)args);
1542 f = (*tab->Open) (aTHX_ tab, layera, n, mode, fd, imode, perm,
1545 SETERRNO(EINVAL, LIB_INVARG);
1549 if (n + 1 < layera->cur) {
1551 * More layers above the one that we used to open -
1554 if (PerlIO_apply_layera(aTHX_ f, mode, layera, n + 1, layera->cur) != 0) {
1555 /* If pushing layers fails close the file */
1562 PerlIO_list_free(aTHX_ layera);
1569 Perl_PerlIO_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
1571 Perl_PerlIO_or_Base(f, Read, read, -1, (aTHX_ f, vbuf, count));
1575 Perl_PerlIO_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
1577 Perl_PerlIO_or_Base(f, Unread, unread, -1, (aTHX_ f, vbuf, count));
1581 Perl_PerlIO_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
1583 Perl_PerlIO_or_fail(f, Write, -1, (aTHX_ f, vbuf, count));
1587 Perl_PerlIO_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
1589 Perl_PerlIO_or_fail(f, Seek, -1, (aTHX_ f, offset, whence));
1593 Perl_PerlIO_tell(pTHX_ PerlIO *f)
1595 Perl_PerlIO_or_fail(f, Tell, -1, (aTHX_ f));
1599 Perl_PerlIO_flush(pTHX_ PerlIO *f)
1603 PerlIO_funcs *tab = PerlIOBase(f)->tab;
1605 if (tab && tab->Flush)
1606 return (*tab->Flush) (aTHX_ f);
1608 return 0; /* If no Flush defined, silently succeed. */
1611 PerlIO_debug("Cannot flush f=%p\n", (void*)f);
1612 SETERRNO(EBADF, SS_IVCHAN);
1618 * Is it good API design to do flush-all on NULL, a potentially
1619 * errorneous input? Maybe some magical value (PerlIO*
1620 * PERLIO_FLUSH_ALL = (PerlIO*)-1;)? Yes, stdio does similar
1621 * things on fflush(NULL), but should we be bound by their design
1624 PerlIO **table = &PL_perlio;
1626 while ((f = *table)) {
1628 table = (PerlIO **) (f++);
1629 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
1630 if (*f && PerlIO_flush(f) != 0)
1640 PerlIOBase_flush_linebuf(pTHX)
1642 PerlIO **table = &PL_perlio;
1644 while ((f = *table)) {
1646 table = (PerlIO **) (f++);
1647 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
1650 flags & (PERLIO_F_LINEBUF | PERLIO_F_CANWRITE))
1651 == (PERLIO_F_LINEBUF | PERLIO_F_CANWRITE))
1659 Perl_PerlIO_fill(pTHX_ PerlIO *f)
1661 Perl_PerlIO_or_fail(f, Fill, -1, (aTHX_ f));
1665 PerlIO_isutf8(PerlIO *f)
1668 return (PerlIOBase(f)->flags & PERLIO_F_UTF8) != 0;
1670 SETERRNO(EBADF, SS_IVCHAN);
1676 Perl_PerlIO_eof(pTHX_ PerlIO *f)
1678 Perl_PerlIO_or_Base(f, Eof, eof, -1, (aTHX_ f));
1682 Perl_PerlIO_error(pTHX_ PerlIO *f)
1684 Perl_PerlIO_or_Base(f, Error, error, -1, (aTHX_ f));
1688 Perl_PerlIO_clearerr(pTHX_ PerlIO *f)
1690 Perl_PerlIO_or_Base_void(f, Clearerr, clearerr, (aTHX_ f));
1694 Perl_PerlIO_setlinebuf(pTHX_ PerlIO *f)
1696 Perl_PerlIO_or_Base_void(f, Setlinebuf, setlinebuf, (aTHX_ f));
1700 PerlIO_has_base(PerlIO *f)
1702 if (PerlIOValid(f)) {
1703 PerlIO_funcs *tab = PerlIOBase(f)->tab;
1706 return (tab->Get_base != NULL);
1707 SETERRNO(EINVAL, LIB_INVARG);
1710 SETERRNO(EBADF, SS_IVCHAN);
1716 PerlIO_fast_gets(PerlIO *f)
1718 if (PerlIOValid(f) && (PerlIOBase(f)->flags & PERLIO_F_FASTGETS)) {
1719 PerlIO_funcs *tab = PerlIOBase(f)->tab;
1722 return (tab->Set_ptrcnt != NULL);
1723 SETERRNO(EINVAL, LIB_INVARG);
1726 SETERRNO(EBADF, SS_IVCHAN);
1732 PerlIO_has_cntptr(PerlIO *f)
1734 if (PerlIOValid(f)) {
1735 PerlIO_funcs *tab = PerlIOBase(f)->tab;
1738 return (tab->Get_ptr != NULL && tab->Get_cnt != NULL);
1739 SETERRNO(EINVAL, LIB_INVARG);
1742 SETERRNO(EBADF, SS_IVCHAN);
1748 PerlIO_canset_cnt(PerlIO *f)
1750 if (PerlIOValid(f)) {
1751 PerlIO_funcs *tab = PerlIOBase(f)->tab;
1754 return (tab->Set_ptrcnt != NULL);
1755 SETERRNO(EINVAL, LIB_INVARG);
1758 SETERRNO(EBADF, SS_IVCHAN);
1764 Perl_PerlIO_get_base(pTHX_ PerlIO *f)
1766 Perl_PerlIO_or_fail(f, Get_base, NULL, (aTHX_ f));
1770 Perl_PerlIO_get_bufsiz(pTHX_ PerlIO *f)
1772 Perl_PerlIO_or_fail(f, Get_bufsiz, -1, (aTHX_ f));
1776 Perl_PerlIO_get_ptr(pTHX_ PerlIO *f)
1778 Perl_PerlIO_or_fail(f, Get_ptr, NULL, (aTHX_ f));
1782 Perl_PerlIO_get_cnt(pTHX_ PerlIO *f)
1784 Perl_PerlIO_or_fail(f, Get_cnt, -1, (aTHX_ f));
1788 Perl_PerlIO_set_cnt(pTHX_ PerlIO *f, int cnt)
1790 Perl_PerlIO_or_fail_void(f, Set_ptrcnt, (aTHX_ f, NULL, cnt));
1794 Perl_PerlIO_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, int cnt)
1796 Perl_PerlIO_or_fail_void(f, Set_ptrcnt, (aTHX_ f, ptr, cnt));
1800 /*--------------------------------------------------------------------------------------*/
1802 * utf8 and raw dummy layers
1806 PerlIOUtf8_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1808 if (PerlIOValid(f)) {
1809 if (tab->kind & PERLIO_K_UTF8)
1810 PerlIOBase(f)->flags |= PERLIO_F_UTF8;
1812 PerlIOBase(f)->flags &= ~PERLIO_F_UTF8;
1818 PERLIO_FUNCS_DECL(PerlIO_utf8) = {
1819 sizeof(PerlIO_funcs),
1822 PERLIO_K_DUMMY | PERLIO_K_UTF8,
1840 NULL, /* get_base */
1841 NULL, /* get_bufsiz */
1844 NULL, /* set_ptrcnt */
1847 PERLIO_FUNCS_DECL(PerlIO_byte) = {
1848 sizeof(PerlIO_funcs),
1869 NULL, /* get_base */
1870 NULL, /* get_bufsiz */
1873 NULL, /* set_ptrcnt */
1877 PerlIORaw_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
1878 IV n, const char *mode, int fd, int imode, int perm,
1879 PerlIO *old, int narg, SV **args)
1881 PerlIO_funcs *tab = PerlIO_default_btm();
1882 if (tab && tab->Open)
1883 return (*tab->Open) (aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
1885 SETERRNO(EINVAL, LIB_INVARG);
1889 PERLIO_FUNCS_DECL(PerlIO_raw) = {
1890 sizeof(PerlIO_funcs),
1911 NULL, /* get_base */
1912 NULL, /* get_bufsiz */
1915 NULL, /* set_ptrcnt */
1917 /*--------------------------------------------------------------------------------------*/
1918 /*--------------------------------------------------------------------------------------*/
1920 * "Methods" of the "base class"
1924 PerlIOBase_fileno(pTHX_ PerlIO *f)
1926 return PerlIOValid(f) ? PerlIO_fileno(PerlIONext(f)) : -1;
1930 PerlIO_modestr(PerlIO * f, char *buf)
1933 if (PerlIOValid(f)) {
1934 IV flags = PerlIOBase(f)->flags;
1935 if (flags & PERLIO_F_APPEND) {
1937 if (flags & PERLIO_F_CANREAD) {
1941 else if (flags & PERLIO_F_CANREAD) {
1943 if (flags & PERLIO_F_CANWRITE)
1946 else if (flags & PERLIO_F_CANWRITE) {
1948 if (flags & PERLIO_F_CANREAD) {
1952 #ifdef PERLIO_USING_CRLF
1953 if (!(flags & PERLIO_F_CRLF))
1963 PerlIOBase_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1965 PerlIOl *l = PerlIOBase(f);
1967 const char *omode = mode;
1970 l->flags &= ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE |
1971 PERLIO_F_TRUNCATE | PERLIO_F_APPEND);
1972 if (tab->Set_ptrcnt != NULL)
1973 l->flags |= PERLIO_F_FASTGETS;
1975 if (*mode == IoTYPE_NUMERIC || *mode == IoTYPE_IMPLICIT)
1979 l->flags |= PERLIO_F_CANREAD;
1982 l->flags |= PERLIO_F_APPEND | PERLIO_F_CANWRITE;
1985 l->flags |= PERLIO_F_TRUNCATE | PERLIO_F_CANWRITE;
1988 SETERRNO(EINVAL, LIB_INVARG);
1994 l->flags |= PERLIO_F_CANREAD | PERLIO_F_CANWRITE;
1997 l->flags &= ~PERLIO_F_CRLF;
2000 l->flags |= PERLIO_F_CRLF;
2003 SETERRNO(EINVAL, LIB_INVARG);
2010 l->flags |= l->next->flags &
2011 (PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_TRUNCATE |
2016 PerlIO_debug("PerlIOBase_pushed f=%p %s %s fl=%08" UVxf " (%s)\n",
2017 f, PerlIOBase(f)->tab->name, (omode) ? omode : "(Null)",
2018 l->flags, PerlIO_modestr(f, temp));
2024 PerlIOBase_popped(pTHX_ PerlIO *f)
2030 PerlIOBase_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
2033 * Save the position as current head considers it
2035 Off_t old = PerlIO_tell(f);
2037 PerlIO_push(aTHX_ f, PERLIO_FUNCS_CAST(&PerlIO_pending), "r", Nullsv);
2038 PerlIOSelf(f, PerlIOBuf)->posn = old;
2039 done = PerlIOBuf_unread(aTHX_ f, vbuf, count);
2044 PerlIOBase_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
2046 STDCHAR *buf = (STDCHAR *) vbuf;
2048 if (!(PerlIOBase(f)->flags & PERLIO_F_CANREAD)) {
2049 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2050 SETERRNO(EBADF, SS_IVCHAN);
2054 SSize_t avail = PerlIO_get_cnt(f);
2057 take = ((SSize_t)count < avail) ? count : avail;
2059 STDCHAR *ptr = PerlIO_get_ptr(f);
2060 Copy(ptr, buf, take, STDCHAR);
2061 PerlIO_set_ptrcnt(f, ptr + take, (avail -= take));
2065 if (count > 0 && avail <= 0) {
2066 if (PerlIO_fill(f) != 0)
2070 return (buf - (STDCHAR *) vbuf);
2076 PerlIOBase_noop_ok(pTHX_ PerlIO *f)
2082 PerlIOBase_noop_fail(pTHX_ PerlIO *f)
2088 PerlIOBase_close(pTHX_ PerlIO *f)
2091 if (PerlIOValid(f)) {
2092 PerlIO *n = PerlIONext(f);
2093 code = PerlIO_flush(f);
2094 PerlIOBase(f)->flags &=
2095 ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_OPEN);
2096 while (PerlIOValid(n)) {
2097 PerlIO_funcs *tab = PerlIOBase(n)->tab;
2098 if (tab && tab->Close) {
2099 if ((*tab->Close)(aTHX_ n) != 0)
2104 PerlIOBase(n)->flags &=
2105 ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_OPEN);
2111 SETERRNO(EBADF, SS_IVCHAN);
2117 PerlIOBase_eof(pTHX_ PerlIO *f)
2119 if (PerlIOValid(f)) {
2120 return (PerlIOBase(f)->flags & PERLIO_F_EOF) != 0;
2126 PerlIOBase_error(pTHX_ PerlIO *f)
2128 if (PerlIOValid(f)) {
2129 return (PerlIOBase(f)->flags & PERLIO_F_ERROR) != 0;
2135 PerlIOBase_clearerr(pTHX_ PerlIO *f)
2137 if (PerlIOValid(f)) {
2138 PerlIO *n = PerlIONext(f);
2139 PerlIOBase(f)->flags &= ~(PERLIO_F_ERROR | PERLIO_F_EOF);
2146 PerlIOBase_setlinebuf(pTHX_ PerlIO *f)
2148 if (PerlIOValid(f)) {
2149 PerlIOBase(f)->flags |= PERLIO_F_LINEBUF;
2154 PerlIO_sv_dup(pTHX_ SV *arg, CLONE_PARAMS *param)
2160 return sv_dup(arg, param);
2163 return newSVsv(arg);
2166 return newSVsv(arg);
2171 PerlIOBase_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2173 PerlIO *nexto = PerlIONext(o);
2174 if (PerlIOValid(nexto)) {
2175 PerlIO_funcs *tab = PerlIOBase(nexto)->tab;
2176 if (tab && tab->Dup)
2177 f = (*tab->Dup)(aTHX_ f, nexto, param, flags);
2179 f = PerlIOBase_dup(aTHX_ f, nexto, param, flags);
2182 PerlIO_funcs *self = PerlIOBase(o)->tab;
2185 PerlIO_debug("PerlIOBase_dup %s f=%p o=%p param=%p\n",
2186 self->name, (void*)f, (void*)o, (void*)param);
2188 arg = (*self->Getarg)(aTHX_ o, param, flags);
2192 f = PerlIO_push(aTHX_ f, self, PerlIO_modestr(o,buf), arg);
2201 perl_mutex PerlIO_mutex;
2204 /* PL_perlio_fd_refcnt[] is in intrpvar.h */
2209 /* Place holder for stdstreams call ??? */
2211 MUTEX_INIT(&PerlIO_mutex);
2216 PerlIOUnix_refcnt_inc(int fd)
2219 if (fd >= 0 && fd < PERLIO_MAX_REFCOUNTABLE_FD) {
2221 MUTEX_LOCK(&PerlIO_mutex);
2223 PL_perlio_fd_refcnt[fd]++;
2224 PerlIO_debug("fd %d refcnt=%d\n",fd,PL_perlio_fd_refcnt[fd]);
2226 MUTEX_UNLOCK(&PerlIO_mutex);
2232 PerlIOUnix_refcnt_dec(int fd)
2236 if (fd >= 0 && fd < PERLIO_MAX_REFCOUNTABLE_FD) {
2238 MUTEX_LOCK(&PerlIO_mutex);
2240 cnt = --PL_perlio_fd_refcnt[fd];
2241 PerlIO_debug("fd %d refcnt=%d\n",fd,cnt);
2243 MUTEX_UNLOCK(&PerlIO_mutex);
2250 PerlIO_cleanup(pTHX)
2254 PerlIO_debug("Cleanup layers for %p\n",aTHX);
2256 PerlIO_debug("Cleanup layers\n");
2258 /* Raise STDIN..STDERR refcount so we don't close them */
2259 for (i=0; i < 3; i++)
2260 PerlIOUnix_refcnt_inc(i);
2261 PerlIO_cleantable(aTHX_ &PL_perlio);
2262 /* Restore STDIN..STDERR refcount */
2263 for (i=0; i < 3; i++)
2264 PerlIOUnix_refcnt_dec(i);
2266 if (PL_known_layers) {
2267 PerlIO_list_free(aTHX_ PL_known_layers);
2268 PL_known_layers = NULL;
2270 if (PL_def_layerlist) {
2271 PerlIO_list_free(aTHX_ PL_def_layerlist);
2272 PL_def_layerlist = NULL;
2278 /*--------------------------------------------------------------------------------------*/
2280 * Bottom-most level for UNIX-like case
2284 struct _PerlIO base; /* The generic part */
2285 int fd; /* UNIX like file descriptor */
2286 int oflags; /* open/fcntl flags */
2290 PerlIOUnix_oflags(const char *mode)
2293 if (*mode == IoTYPE_IMPLICIT || *mode == IoTYPE_NUMERIC)
2298 if (*++mode == '+') {
2305 oflags = O_CREAT | O_TRUNC;
2306 if (*++mode == '+') {
2315 oflags = O_CREAT | O_APPEND;
2316 if (*++mode == '+') {
2329 else if (*mode == 't') {
2331 oflags &= ~O_BINARY;
2335 * Always open in binary mode
2338 if (*mode || oflags == -1) {
2339 SETERRNO(EINVAL, LIB_INVARG);
2346 PerlIOUnix_fileno(pTHX_ PerlIO *f)
2348 return PerlIOSelf(f, PerlIOUnix)->fd;
2352 PerlIOUnix_setfd(pTHX_ PerlIO *f, int fd, int imode)
2354 PerlIOUnix *s = PerlIOSelf(f, PerlIOUnix);
2357 if (PerlLIO_fstat(fd, &st) == 0) {
2358 if (!S_ISREG(st.st_mode)) {
2359 PerlIO_debug("%d is not regular file\n",fd);
2360 PerlIOBase(f)->flags |= PERLIO_F_NOTREG;
2363 PerlIO_debug("%d _is_ a regular file\n",fd);
2369 PerlIOUnix_refcnt_inc(fd);
2373 PerlIOUnix_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2375 IV code = PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
2376 if (*PerlIONext(f)) {
2377 /* We never call down so do any pending stuff now */
2378 PerlIO_flush(PerlIONext(f));
2380 * XXX could (or should) we retrieve the oflags from the open file
2381 * handle rather than believing the "mode" we are passed in? XXX
2382 * Should the value on NULL mode be 0 or -1?
2384 PerlIOUnix_setfd(aTHX_ f, PerlIO_fileno(PerlIONext(f)),
2385 mode ? PerlIOUnix_oflags(mode) : -1);
2387 PerlIOBase(f)->flags |= PERLIO_F_OPEN;
2393 PerlIOUnix_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
2395 int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2397 if (PerlIOBase(f)->flags & PERLIO_F_NOTREG) {
2399 SETERRNO(ESPIPE, LIB_INVARG);
2401 SETERRNO(EINVAL, LIB_INVARG);
2405 new_loc = PerlLIO_lseek(fd, offset, whence);
2406 if (new_loc == (Off_t) - 1)
2410 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
2415 PerlIOUnix_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
2416 IV n, const char *mode, int fd, int imode,
2417 int perm, PerlIO *f, int narg, SV **args)
2419 if (PerlIOValid(f)) {
2420 if (PerlIOBase(f)->flags & PERLIO_F_OPEN)
2421 (*PerlIOBase(f)->tab->Close)(aTHX_ f);
2424 char *path = SvPV_nolen(*args);
2425 if (*mode == IoTYPE_NUMERIC)
2428 imode = PerlIOUnix_oflags(mode);
2432 fd = PerlLIO_open3(path, imode, perm);
2436 if (*mode == IoTYPE_IMPLICIT)
2439 f = PerlIO_allocate(aTHX);
2441 if (!PerlIOValid(f)) {
2442 if (!(f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg))) {
2446 PerlIOUnix_setfd(aTHX_ f, fd, imode);
2447 PerlIOBase(f)->flags |= PERLIO_F_OPEN;
2448 if (*mode == IoTYPE_APPEND)
2449 PerlIOUnix_seek(aTHX_ f, 0, SEEK_END);
2455 * FIXME: pop layers ???
2463 PerlIOUnix_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2465 PerlIOUnix *os = PerlIOSelf(o, PerlIOUnix);
2467 if (flags & PERLIO_DUP_FD) {
2468 fd = PerlLIO_dup(fd);
2470 if (fd >= 0 && fd < PERLIO_MAX_REFCOUNTABLE_FD) {
2471 f = PerlIOBase_dup(aTHX_ f, o, param, flags);
2473 /* If all went well overwrite fd in dup'ed lay with the dup()'ed fd */
2474 PerlIOUnix_setfd(aTHX_ f, fd, os->oflags);
2483 PerlIOUnix_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
2485 int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2486 #ifdef PERLIO_STD_SPECIAL
2488 return PERLIO_STD_IN(fd, vbuf, count);
2490 if (!(PerlIOBase(f)->flags & PERLIO_F_CANREAD) ||
2491 PerlIOBase(f)->flags & (PERLIO_F_EOF|PERLIO_F_ERROR)) {
2495 SSize_t len = PerlLIO_read(fd, vbuf, count);
2496 if (len >= 0 || errno != EINTR) {
2498 if (errno != EAGAIN) {
2499 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2502 else if (len == 0 && count != 0) {
2503 PerlIOBase(f)->flags |= PERLIO_F_EOF;
2513 PerlIOUnix_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
2515 int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2516 #ifdef PERLIO_STD_SPECIAL
2517 if (fd == 1 || fd == 2)
2518 return PERLIO_STD_OUT(fd, vbuf, count);
2521 SSize_t len = PerlLIO_write(fd, vbuf, count);
2522 if (len >= 0 || errno != EINTR) {
2524 if (errno != EAGAIN) {
2525 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2535 PerlIOUnix_tell(pTHX_ PerlIO *f)
2537 return PerlLIO_lseek(PerlIOSelf(f, PerlIOUnix)->fd, 0, SEEK_CUR);
2542 PerlIOUnix_close(pTHX_ PerlIO *f)
2544 int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2546 if (PerlIOBase(f)->flags & PERLIO_F_OPEN) {
2547 if (PerlIOUnix_refcnt_dec(fd) > 0) {
2548 PerlIOBase(f)->flags &= ~PERLIO_F_OPEN;
2553 SETERRNO(EBADF,SS_IVCHAN);
2556 while (PerlLIO_close(fd) != 0) {
2557 if (errno != EINTR) {
2564 PerlIOBase(f)->flags &= ~PERLIO_F_OPEN;
2569 PERLIO_FUNCS_DECL(PerlIO_unix) = {
2570 sizeof(PerlIO_funcs),
2577 PerlIOBase_binmode, /* binmode */
2587 PerlIOBase_noop_ok, /* flush */
2588 PerlIOBase_noop_fail, /* fill */
2591 PerlIOBase_clearerr,
2592 PerlIOBase_setlinebuf,
2593 NULL, /* get_base */
2594 NULL, /* get_bufsiz */
2597 NULL, /* set_ptrcnt */
2600 /*--------------------------------------------------------------------------------------*/
2605 #if defined(VMS) && !defined(STDIO_BUFFER_WRITABLE)
2606 /* perl5.8 - This ensures the last minute VMS ungetc fix is not
2607 broken by the last second glibc 2.3 fix
2609 #define STDIO_BUFFER_WRITABLE
2614 struct _PerlIO base;
2615 FILE *stdio; /* The stream */
2619 PerlIOStdio_fileno(pTHX_ PerlIO *f)
2622 if (PerlIOValid(f) && (s = PerlIOSelf(f, PerlIOStdio)->stdio)) {
2623 return PerlSIO_fileno(s);
2630 PerlIOStdio_mode(const char *mode, char *tmode)
2638 #if defined(PERLIO_USING_CRLF) || defined(__CYGWIN__)
2646 PerlIOStdio_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2649 if (PerlIOValid(f) && PerlIOValid(n = PerlIONext(f))) {
2650 PerlIO_funcs *toptab = PerlIOBase(n)->tab;
2651 if (toptab == tab) {
2652 /* Top is already stdio - pop self (duplicate) and use original */
2653 PerlIO_pop(aTHX_ f);
2656 int fd = PerlIO_fileno(n);
2659 if (fd >= 0 && (stdio = PerlSIO_fdopen(fd,
2660 mode = PerlIOStdio_mode(mode, tmode)))) {
2661 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2662 /* We never call down so do any pending stuff now */
2663 PerlIO_flush(PerlIONext(f));
2670 return PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
2675 PerlIO_importFILE(FILE *stdio, const char *mode)
2681 if (!mode || !*mode) {
2682 /* We need to probe to see how we can open the stream
2683 so start with read/write and then try write and read
2684 we dup() so that we can fclose without loosing the fd.
2686 Note that the errno value set by a failing fdopen
2687 varies between stdio implementations.
2689 int fd = PerlLIO_dup(fileno(stdio));
2690 FILE *f2 = PerlSIO_fdopen(fd, (mode = "r+"));
2692 f2 = PerlSIO_fdopen(fd, (mode = "w"));
2695 f2 = PerlSIO_fdopen(fd, (mode = "r"));
2698 /* Don't seem to be able to open */
2704 if ((f = PerlIO_push(aTHX_(f = PerlIO_allocate(aTHX)), PERLIO_FUNCS_CAST(&PerlIO_stdio), mode, Nullsv))) {
2705 s = PerlIOSelf(f, PerlIOStdio);
2713 PerlIOStdio_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
2714 IV n, const char *mode, int fd, int imode,
2715 int perm, PerlIO *f, int narg, SV **args)
2718 if (PerlIOValid(f)) {
2719 char *path = SvPV_nolen(*args);
2720 PerlIOStdio *s = PerlIOSelf(f, PerlIOStdio);
2722 PerlIOUnix_refcnt_dec(fileno(s->stdio));
2723 stdio = PerlSIO_freopen(path, (mode = PerlIOStdio_mode(mode, tmode)),
2728 PerlIOUnix_refcnt_inc(fileno(s->stdio));
2733 char *path = SvPV_nolen(*args);
2734 if (*mode == IoTYPE_NUMERIC) {
2736 fd = PerlLIO_open3(path, imode, perm);
2740 bool appended = FALSE;
2742 /* Cygwin wants its 'b' early. */
2744 mode = PerlIOStdio_mode(mode, tmode);
2746 stdio = PerlSIO_fopen(path, mode);
2750 f = PerlIO_allocate(aTHX);
2753 mode = PerlIOStdio_mode(mode, tmode);
2754 f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg);
2756 s = PerlIOSelf(f, PerlIOStdio);
2758 PerlIOUnix_refcnt_inc(fileno(s->stdio));
2770 if (*mode == IoTYPE_IMPLICIT) {
2777 stdio = PerlSIO_stdin;
2780 stdio = PerlSIO_stdout;
2783 stdio = PerlSIO_stderr;
2788 stdio = PerlSIO_fdopen(fd, mode =
2789 PerlIOStdio_mode(mode, tmode));
2794 f = PerlIO_allocate(aTHX);
2796 if ((f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg))) {
2797 s = PerlIOSelf(f, PerlIOStdio);
2799 PerlIOUnix_refcnt_inc(fileno(s->stdio));
2809 PerlIOStdio_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2811 /* This assumes no layers underneath - which is what
2812 happens, but is not how I remember it. NI-S 2001/10/16
2814 if ((f = PerlIOBase_dup(aTHX_ f, o, param, flags))) {
2815 FILE *stdio = PerlIOSelf(o, PerlIOStdio)->stdio;
2816 int fd = fileno(stdio);
2818 if (flags & PERLIO_DUP_FD) {
2819 int dfd = PerlLIO_dup(fileno(stdio));
2821 stdio = PerlSIO_fdopen(dfd, PerlIO_modestr(o,mode));
2825 /* FIXME: To avoid messy error recovery if dup fails
2826 re-use the existing stdio as though flag was not set
2830 stdio = PerlSIO_fdopen(fd, PerlIO_modestr(o,mode));
2832 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2833 PerlIOUnix_refcnt_inc(fileno(stdio));
2839 PerlIOStdio_invalidate_fileno(pTHX_ FILE *f)
2841 /* XXX this could use PerlIO_canset_fileno() and
2842 * PerlIO_set_fileno() support from Configure
2844 # if defined(__UCLIBC__)
2845 /* uClibc must come before glibc because it defines __GLIBC__ as well. */
2848 # elif defined(__GLIBC__)
2849 /* There may be a better way for GLIBC:
2850 - libio.h defines a flag to not close() on cleanup
2854 # elif defined(__sun__)
2856 /* On solaris, if _LP64 is defined, the FILE structure is this:
2862 * It turns out that the fd is stored in the top 32 bits of
2863 * file->__pad[4]. The lower 32 bits contain flags. file->pad[5] appears
2864 * to contain a pointer or offset into another structure. All the
2865 * remaining fields are zero.
2867 * We set the top bits to -1 (0xFFFFFFFF).
2869 f->__pad[4] |= 0xffffffff00000000L;
2870 assert(fileno(f) == 0xffffffff);
2871 # else /* !defined(_LP64) */
2872 /* _file is just a unsigned char :-(
2873 Not clear why we dup() rather than using -1
2874 even if that would be treated as 0xFF - so will
2877 f->_file = PerlLIO_dup(fileno(f));
2878 # endif /* defined(_LP64) */
2880 # elif defined(__hpux)
2884 /* Next one ->_file seems to be a reasonable fallback, i.e. if
2885 your platform does not have special entry try this one.
2886 [For OSF only have confirmation for Tru64 (alpha)
2887 but assume other OSFs will be similar.]
2889 # elif defined(_AIX) || defined(__osf__) || defined(__irix__)
2892 # elif defined(__FreeBSD__)
2893 /* There may be a better way on FreeBSD:
2894 - we could insert a dummy func in the _close function entry
2895 f->_close = (int (*)(void *)) dummy_close;
2899 # elif defined(__OpenBSD__)
2900 /* There may be a better way on OpenBSD:
2901 - we could insert a dummy func in the _close function entry
2902 f->_close = (int (*)(void *)) dummy_close;
2906 # elif defined(__EMX__)
2907 /* f->_flags &= ~_IOOPEN; */ /* Will leak stream->_buffer */
2910 # elif defined(__CYGWIN__)
2911 /* There may be a better way on CYGWIN:
2912 - we could insert a dummy func in the _close function entry
2913 f->_close = (int (*)(void *)) dummy_close;
2917 # elif defined(WIN32)
2918 # if defined(__BORLANDC__)
2919 f->fd = PerlLIO_dup(fileno(f));
2920 # elif defined(UNDER_CE)
2921 /* WIN_CE does not have access to FILE internals, it hardly has FILE
2930 /* Sarathy's code did this - we fall back to a dup/dup2 hack
2931 (which isn't thread safe) instead
2933 # error "Don't know how to set FILE.fileno on your platform"
2940 PerlIOStdio_close(pTHX_ PerlIO *f)
2942 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
2948 int fd = fileno(stdio);
2954 #ifdef SOCKS5_VERSION_NAME
2955 /* Socks lib overrides close() but stdio isn't linked to
2956 that library (though we are) - so we must call close()
2957 on sockets on stdio's behalf.
2960 Sock_size_t optlen = sizeof(int);
2961 if (getsockopt(fd, SOL_SOCKET, SO_TYPE, (void *) &optval, &optlen) == 0) {
2966 if (PerlIOUnix_refcnt_dec(fd) > 0) {
2967 /* File descriptor still in use */
2972 /* For STD* handles don't close the stdio at all
2973 this is because we have shared the FILE * too
2975 if (stdio == stdin) {
2976 /* Some stdios are buggy fflush-ing inputs */
2979 else if (stdio == stdout || stdio == stderr) {
2980 return PerlIO_flush(f);
2982 /* Tricky - must fclose(stdio) to free memory but not close(fd)
2983 Use Sarathy's trick from maint-5.6 to invalidate the
2984 fileno slot of the FILE *
2986 result = PerlIO_flush(f);
2988 if (!(invalidate = PerlIOStdio_invalidate_fileno(aTHX_ stdio))) {
2989 dupfd = PerlLIO_dup(fd);
2992 result = PerlSIO_fclose(stdio);
2993 /* We treat error from stdio as success if we invalidated
2994 errno may NOT be expected EBADF
2996 if (invalidate && result != 0) {
3001 /* in SOCKS case let close() determine return value */
3005 PerlLIO_dup2(dupfd,fd);
3006 PerlLIO_close(dupfd);
3013 PerlIOStdio_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
3015 FILE *s = PerlIOSelf(f, PerlIOStdio)->stdio;
3019 STDCHAR *buf = (STDCHAR *) vbuf;
3021 * Perl is expecting PerlIO_getc() to fill the buffer Linux's
3022 * stdio does not do that for fread()
3024 int ch = PerlSIO_fgetc(s);
3031 got = PerlSIO_fread(vbuf, 1, count, s);
3032 if (got == 0 && PerlSIO_ferror(s))
3034 if (got >= 0 || errno != EINTR)
3037 SETERRNO(0,0); /* just in case */
3043 PerlIOStdio_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3046 FILE *s = PerlIOSelf(f, PerlIOStdio)->stdio;
3048 #ifdef STDIO_BUFFER_WRITABLE
3049 if (PerlIO_fast_gets(f) && PerlIO_has_base(f)) {
3050 STDCHAR *buf = ((STDCHAR *) vbuf) + count;
3051 STDCHAR *base = PerlIO_get_base(f);
3052 SSize_t cnt = PerlIO_get_cnt(f);
3053 STDCHAR *ptr = PerlIO_get_ptr(f);
3054 SSize_t avail = ptr - base;
3056 if (avail > count) {
3060 Move(buf-avail,ptr,avail,STDCHAR);
3063 PerlIO_set_ptrcnt(f,ptr,cnt+avail);
3064 if (PerlSIO_feof(s) && unread >= 0)
3065 PerlSIO_clearerr(s);
3070 if (PerlIO_has_cntptr(f)) {
3071 /* We can get pointer to buffer but not its base
3072 Do ungetc() but check chars are ending up in the
3075 STDCHAR *eptr = (STDCHAR*)PerlSIO_get_ptr(s);
3076 STDCHAR *buf = ((STDCHAR *) vbuf) + count;
3078 int ch = *--buf & 0xFF;
3079 if (ungetc(ch,s) != ch) {
3080 /* ungetc did not work */
3083 if ((STDCHAR*)PerlSIO_get_ptr(s) != --eptr || ((*eptr & 0xFF) != ch)) {
3084 /* Did not change pointer as expected */
3085 fgetc(s); /* get char back again */
3095 unread += PerlIOBase_unread(aTHX_ f, vbuf, count);
3101 PerlIOStdio_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3105 got = PerlSIO_fwrite(vbuf, 1, count,
3106 PerlIOSelf(f, PerlIOStdio)->stdio);
3107 if (got >= 0 || errno != EINTR)
3110 SETERRNO(0,0); /* just in case */
3116 PerlIOStdio_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3118 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3119 return PerlSIO_fseek(stdio, offset, whence);
3123 PerlIOStdio_tell(pTHX_ PerlIO *f)
3125 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3126 return PerlSIO_ftell(stdio);
3130 PerlIOStdio_flush(pTHX_ PerlIO *f)
3132 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3133 if (PerlIOBase(f)->flags & PERLIO_F_CANWRITE) {
3134 return PerlSIO_fflush(stdio);
3139 * FIXME: This discards ungetc() and pre-read stuff which is not
3140 * right if this is just a "sync" from a layer above Suspect right
3141 * design is to do _this_ but not have layer above flush this
3142 * layer read-to-read
3145 * Not writeable - sync by attempting a seek
3148 if (PerlSIO_fseek(stdio, (Off_t) 0, SEEK_CUR) != 0)
3156 PerlIOStdio_eof(pTHX_ PerlIO *f)
3158 return PerlSIO_feof(PerlIOSelf(f, PerlIOStdio)->stdio);
3162 PerlIOStdio_error(pTHX_ PerlIO *f)
3164 return PerlSIO_ferror(PerlIOSelf(f, PerlIOStdio)->stdio);
3168 PerlIOStdio_clearerr(pTHX_ PerlIO *f)
3170 PerlSIO_clearerr(PerlIOSelf(f, PerlIOStdio)->stdio);
3174 PerlIOStdio_setlinebuf(pTHX_ PerlIO *f)
3176 #ifdef HAS_SETLINEBUF
3177 PerlSIO_setlinebuf(PerlIOSelf(f, PerlIOStdio)->stdio);
3179 PerlSIO_setvbuf(PerlIOSelf(f, PerlIOStdio)->stdio, Nullch, _IOLBF, 0);
3185 PerlIOStdio_get_base(pTHX_ PerlIO *f)
3187 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3188 return (STDCHAR*)PerlSIO_get_base(stdio);
3192 PerlIOStdio_get_bufsiz(pTHX_ PerlIO *f)
3194 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3195 return PerlSIO_get_bufsiz(stdio);
3199 #ifdef USE_STDIO_PTR
3201 PerlIOStdio_get_ptr(pTHX_ PerlIO *f)
3203 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3204 return (STDCHAR*)PerlSIO_get_ptr(stdio);
3208 PerlIOStdio_get_cnt(pTHX_ PerlIO *f)
3210 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3211 return PerlSIO_get_cnt(stdio);
3215 PerlIOStdio_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
3217 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3219 #ifdef STDIO_PTR_LVALUE
3220 PerlSIO_set_ptr(stdio, (void*)ptr); /* LHS STDCHAR* cast non-portable */
3221 #ifdef STDIO_PTR_LVAL_SETS_CNT
3222 if (PerlSIO_get_cnt(stdio) != (cnt)) {
3223 assert(PerlSIO_get_cnt(stdio) == (cnt));
3226 #if (!defined(STDIO_PTR_LVAL_NOCHANGE_CNT))
3228 * Setting ptr _does_ change cnt - we are done
3232 #else /* STDIO_PTR_LVALUE */
3234 #endif /* STDIO_PTR_LVALUE */
3237 * Now (or only) set cnt
3239 #ifdef STDIO_CNT_LVALUE
3240 PerlSIO_set_cnt(stdio, cnt);
3241 #else /* STDIO_CNT_LVALUE */
3242 #if (defined(STDIO_PTR_LVALUE) && defined(STDIO_PTR_LVAL_SETS_CNT))
3243 PerlSIO_set_ptr(stdio,
3244 PerlSIO_get_ptr(stdio) + (PerlSIO_get_cnt(stdio) -
3246 #else /* STDIO_PTR_LVAL_SETS_CNT */
3248 #endif /* STDIO_PTR_LVAL_SETS_CNT */
3249 #endif /* STDIO_CNT_LVALUE */
3256 PerlIOStdio_fill(pTHX_ PerlIO *f)
3258 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3261 * fflush()ing read-only streams can cause trouble on some stdio-s
3263 if ((PerlIOBase(f)->flags & PERLIO_F_CANWRITE)) {
3264 if (PerlSIO_fflush(stdio) != 0)
3267 c = PerlSIO_fgetc(stdio);
3271 #if (defined(STDIO_PTR_LVALUE) && (defined(STDIO_CNT_LVALUE) || defined(STDIO_PTR_LVAL_SETS_CNT)))
3273 #ifdef STDIO_BUFFER_WRITABLE
3274 if (PerlIO_fast_gets(f) && PerlIO_has_base(f)) {
3275 /* Fake ungetc() to the real buffer in case system's ungetc
3278 STDCHAR *base = (STDCHAR*)PerlSIO_get_base(stdio);
3279 SSize_t cnt = PerlSIO_get_cnt(stdio);
3280 STDCHAR *ptr = (STDCHAR*)PerlSIO_get_ptr(stdio);
3281 if (ptr == base+1) {
3282 *--ptr = (STDCHAR) c;
3283 PerlIOStdio_set_ptrcnt(aTHX_ f,ptr,cnt+1);
3284 if (PerlSIO_feof(stdio))
3285 PerlSIO_clearerr(stdio);
3291 if (PerlIO_has_cntptr(f)) {
3293 if (PerlIOStdio_unread(aTHX_ f,&ch,1) == 1) {
3300 /* An ungetc()d char is handled separately from the regular
3301 * buffer, so we stuff it in the buffer ourselves.
3302 * Should never get called as should hit code above
3304 *(--((*stdio)->_ptr)) = (unsigned char) c;
3307 /* If buffer snoop scheme above fails fall back to
3310 if (PerlSIO_ungetc(c, stdio) != c)
3318 PERLIO_FUNCS_DECL(PerlIO_stdio) = {
3319 sizeof(PerlIO_funcs),
3321 sizeof(PerlIOStdio),
3322 PERLIO_K_BUFFERED|PERLIO_K_RAW,
3326 PerlIOBase_binmode, /* binmode */
3340 PerlIOStdio_clearerr,
3341 PerlIOStdio_setlinebuf,
3343 PerlIOStdio_get_base,
3344 PerlIOStdio_get_bufsiz,
3349 #ifdef USE_STDIO_PTR
3350 PerlIOStdio_get_ptr,
3351 PerlIOStdio_get_cnt,
3352 # if defined(HAS_FAST_STDIO) && defined(USE_FAST_STDIO)
3353 PerlIOStdio_set_ptrcnt,
3356 # endif /* HAS_FAST_STDIO && USE_FAST_STDIO */
3361 #endif /* USE_STDIO_PTR */
3364 /* Note that calls to PerlIO_exportFILE() are reversed using
3365 * PerlIO_releaseFILE(), not importFILE. */
3367 PerlIO_exportFILE(PerlIO * f, const char *mode)
3371 if (PerlIOValid(f)) {
3374 if (!mode || !*mode) {
3375 mode = PerlIO_modestr(f, buf);
3377 stdio = PerlSIO_fdopen(PerlIO_fileno(f), mode);
3381 /* De-link any lower layers so new :stdio sticks */
3383 if ((f2 = PerlIO_push(aTHX_ f, PERLIO_FUNCS_CAST(&PerlIO_stdio), buf, Nullsv))) {
3384 PerlIOStdio *s = PerlIOSelf((f = f2), PerlIOStdio);
3386 /* Link previous lower layers under new one */
3390 /* restore layers list */
3400 PerlIO_findFILE(PerlIO *f)
3404 if (l->tab == &PerlIO_stdio) {
3405 PerlIOStdio *s = PerlIOSelf(&l, PerlIOStdio);
3408 l = *PerlIONext(&l);
3410 /* Uses fallback "mode" via PerlIO_modestr() in PerlIO_exportFILE */
3411 return PerlIO_exportFILE(f, Nullch);
3414 /* Use this to reverse PerlIO_exportFILE calls. */
3416 PerlIO_releaseFILE(PerlIO *p, FILE *f)
3421 if (l->tab == &PerlIO_stdio) {
3422 PerlIOStdio *s = PerlIOSelf(&l, PerlIOStdio);
3423 if (s->stdio == f) {
3425 PerlIO_pop(aTHX_ p);
3434 /*--------------------------------------------------------------------------------------*/
3436 * perlio buffer layer
3440 PerlIOBuf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
3442 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3443 int fd = PerlIO_fileno(f);
3444 if (fd >= 0 && PerlLIO_isatty(fd)) {
3445 PerlIOBase(f)->flags |= PERLIO_F_LINEBUF | PERLIO_F_TTY;
3447 if (*PerlIONext(f)) {
3448 Off_t posn = PerlIO_tell(PerlIONext(f));
3449 if (posn != (Off_t) - 1) {
3453 return PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
3457 PerlIOBuf_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
3458 IV n, const char *mode, int fd, int imode, int perm,
3459 PerlIO *f, int narg, SV **args)
3461 if (PerlIOValid(f)) {
3462 PerlIO *next = PerlIONext(f);
3464 PerlIO_layer_fetch(aTHX_ layers, n - 1, PerlIOBase(next)->tab);
3465 if (tab && tab->Open)
3467 (*tab->Open)(aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
3469 if (!next || (*PerlIOBase(f)->tab->Pushed) (aTHX_ f, mode, PerlIOArg, self) != 0) {
3474 PerlIO_funcs *tab = PerlIO_layer_fetch(aTHX_ layers, n - 1, PerlIO_default_btm());
3476 if (*mode == IoTYPE_IMPLICIT) {
3482 if (tab && tab->Open)
3483 f = (*tab->Open)(aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
3486 SETERRNO(EINVAL, LIB_INVARG);
3488 if (PerlIO_push(aTHX_ f, self, mode, PerlIOArg) == 0) {
3490 * if push fails during open, open fails. close will pop us.
3495 fd = PerlIO_fileno(f);
3496 if (init && fd == 2) {
3498 * Initial stderr is unbuffered
3500 PerlIOBase(f)->flags |= PERLIO_F_UNBUF;
3502 #ifdef PERLIO_USING_CRLF
3503 # ifdef PERLIO_IS_BINMODE_FD
3504 if (PERLIO_IS_BINMODE_FD(fd))
3505 PerlIO_binmode(aTHX_ f, '<'/*not used*/, O_BINARY, Nullch);
3509 * do something about failing setmode()? --jhi
3511 PerlLIO_setmode(fd, O_BINARY);
3520 * This "flush" is akin to sfio's sync in that it handles files in either
3521 * read or write state
3524 PerlIOBuf_flush(pTHX_ PerlIO *f)
3526 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3528 PerlIO *n = PerlIONext(f);
3529 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF) {
3531 * write() the buffer
3533 STDCHAR *buf = b->buf;
3535 while (p < b->ptr) {
3536 SSize_t count = PerlIO_write(n, p, b->ptr - p);
3540 else if (count < 0 || PerlIO_error(n)) {
3541 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
3546 b->posn += (p - buf);
3548 else if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3549 STDCHAR *buf = PerlIO_get_base(f);
3551 * Note position change
3553 b->posn += (b->ptr - buf);
3554 if (b->ptr < b->end) {
3555 /* We did not consume all of it - try and seek downstream to
3556 our logical position
3558 if (PerlIOValid(n) && PerlIO_seek(n, b->posn, SEEK_SET) == 0) {
3559 /* Reload n as some layers may pop themselves on seek */
3560 b->posn = PerlIO_tell(n = PerlIONext(f));
3563 /* Seek failed (e.g. pipe or tty). Do NOT clear buffer or pre-read
3564 data is lost for good - so return saying "ok" having undone
3567 b->posn -= (b->ptr - buf);
3572 b->ptr = b->end = b->buf;
3573 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3574 /* We check for Valid because of dubious decision to make PerlIO_flush(NULL) flush all */
3575 if (PerlIOValid(n) && PerlIO_flush(n) != 0)
3581 PerlIOBuf_fill(pTHX_ PerlIO *f)
3583 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3584 PerlIO *n = PerlIONext(f);
3587 * Down-stream flush is defined not to loose read data so is harmless.
3588 * we would not normally be fill'ing if there was data left in anycase.
3590 if (PerlIO_flush(f) != 0)
3592 if (PerlIOBase(f)->flags & PERLIO_F_TTY)
3593 PerlIOBase_flush_linebuf(aTHX);
3596 PerlIO_get_base(f); /* allocate via vtable */
3598 b->ptr = b->end = b->buf;
3600 if (!PerlIOValid(n)) {
3601 PerlIOBase(f)->flags |= PERLIO_F_EOF;
3605 if (PerlIO_fast_gets(n)) {
3607 * Layer below is also buffered. We do _NOT_ want to call its
3608 * ->Read() because that will loop till it gets what we asked for
3609 * which may hang on a pipe etc. Instead take anything it has to
3610 * hand, or ask it to fill _once_.
3612 avail = PerlIO_get_cnt(n);
3614 avail = PerlIO_fill(n);
3616 avail = PerlIO_get_cnt(n);
3618 if (!PerlIO_error(n) && PerlIO_eof(n))
3623 STDCHAR *ptr = PerlIO_get_ptr(n);
3624 SSize_t cnt = avail;
3625 if (avail > (SSize_t)b->bufsiz)
3627 Copy(ptr, b->buf, avail, STDCHAR);
3628 PerlIO_set_ptrcnt(n, ptr + avail, cnt - avail);
3632 avail = PerlIO_read(n, b->ptr, b->bufsiz);
3636 PerlIOBase(f)->flags |= PERLIO_F_EOF;
3638 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
3641 b->end = b->buf + avail;
3642 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3647 PerlIOBuf_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
3649 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3650 if (PerlIOValid(f)) {
3653 return PerlIOBase_read(aTHX_ f, vbuf, count);
3659 PerlIOBuf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3661 const STDCHAR *buf = (const STDCHAR *) vbuf + count;
3662 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3665 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
3670 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3672 * Buffer is already a read buffer, we can overwrite any chars
3673 * which have been read back to buffer start
3675 avail = (b->ptr - b->buf);
3679 * Buffer is idle, set it up so whole buffer is available for
3683 b->end = b->buf + avail;
3685 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3687 * Buffer extends _back_ from where we are now
3689 b->posn -= b->bufsiz;
3691 if (avail > (SSize_t) count) {
3693 * If we have space for more than count, just move count
3701 * In simple stdio-like ungetc() case chars will be already
3704 if (buf != b->ptr) {
3705 Copy(buf, b->ptr, avail, STDCHAR);
3709 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
3713 unread += PerlIOBase_unread(aTHX_ f, vbuf, count);
3719 PerlIOBuf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3721 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3722 const STDCHAR *buf = (const STDCHAR *) vbuf;
3723 const STDCHAR *flushptr = buf;
3727 if (!(PerlIOBase(f)->flags & PERLIO_F_CANWRITE))
3729 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3730 if (PerlIO_flush(f) != 0) {
3734 if (PerlIOBase(f)->flags & PERLIO_F_LINEBUF) {
3735 flushptr = buf + count;
3736 while (flushptr > buf && *(flushptr - 1) != '\n')
3740 SSize_t avail = b->bufsiz - (b->ptr - b->buf);
3741 if ((SSize_t) count < avail)
3743 if (flushptr > buf && flushptr <= buf + avail)
3744 avail = flushptr - buf;
3745 PerlIOBase(f)->flags |= PERLIO_F_WRBUF;
3747 Copy(buf, b->ptr, avail, STDCHAR);
3752 if (buf == flushptr)
3755 if (b->ptr >= (b->buf + b->bufsiz))
3758 if (PerlIOBase(f)->flags & PERLIO_F_UNBUF)
3764 PerlIOBuf_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3767 if ((code = PerlIO_flush(f)) == 0) {
3768 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3769 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
3770 code = PerlIO_seek(PerlIONext(f), offset, whence);
3772 b->posn = PerlIO_tell(PerlIONext(f));
3779 PerlIOBuf_tell(pTHX_ PerlIO *f)
3781 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3783 * b->posn is file position where b->buf was read, or will be written
3785 Off_t posn = b->posn;
3786 if ((PerlIOBase(f)->flags & PERLIO_F_APPEND) &&
3787 (PerlIOBase(f)->flags & PERLIO_F_WRBUF)) {
3789 /* As O_APPEND files are normally shared in some sense it is better
3794 /* when file is NOT shared then this is sufficient */
3795 PerlIO_seek(PerlIONext(f),0, SEEK_END);
3797 posn = b->posn = PerlIO_tell(PerlIONext(f));
3801 * If buffer is valid adjust position by amount in buffer
3803 posn += (b->ptr - b->buf);
3809 PerlIOBuf_popped(pTHX_ PerlIO *f)
3811 IV code = PerlIOBase_popped(aTHX_ f);
3812 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3813 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
3817 b->ptr = b->end = b->buf;
3818 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3823 PerlIOBuf_close(pTHX_ PerlIO *f)
3825 IV code = PerlIOBase_close(aTHX_ f);
3826 PerlIOBuf *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_get_ptr(pTHX_ PerlIO *f)
3839 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3846 PerlIOBuf_get_cnt(pTHX_ PerlIO *f)
3848 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3851 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF)
3852 return (b->end - b->ptr);
3857 PerlIOBuf_get_base(pTHX_ PerlIO *f)
3859 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3864 Newz('B',b->buf,b->bufsiz, STDCHAR);
3866 b->buf = (STDCHAR *) & b->oneword;
3867 b->bufsiz = sizeof(b->oneword);
3876 PerlIOBuf_bufsiz(pTHX_ PerlIO *f)
3878 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3881 return (b->end - b->buf);
3885 PerlIOBuf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
3887 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3891 if (PerlIO_get_cnt(f) != cnt || b->ptr < b->buf) {
3892 assert(PerlIO_get_cnt(f) == cnt);
3893 assert(b->ptr >= b->buf);
3895 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3899 PerlIOBuf_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
3901 return PerlIOBase_dup(aTHX_ f, o, param, flags);
3906 PERLIO_FUNCS_DECL(PerlIO_perlio) = {
3907 sizeof(PerlIO_funcs),
3910 PERLIO_K_BUFFERED|PERLIO_K_RAW,
3914 PerlIOBase_binmode, /* binmode */
3928 PerlIOBase_clearerr,
3929 PerlIOBase_setlinebuf,
3934 PerlIOBuf_set_ptrcnt,
3937 /*--------------------------------------------------------------------------------------*/
3939 * Temp layer to hold unread chars when cannot do it any other way
3943 PerlIOPending_fill(pTHX_ PerlIO *f)
3946 * Should never happen
3953 PerlIOPending_close(pTHX_ PerlIO *f)
3956 * A tad tricky - flush pops us, then we close new top
3959 return PerlIO_close(f);
3963 PerlIOPending_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3966 * A tad tricky - flush pops us, then we seek new top
3969 return PerlIO_seek(f, offset, whence);
3974 PerlIOPending_flush(pTHX_ PerlIO *f)
3976 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3977 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
3981 PerlIO_pop(aTHX_ f);
3986 PerlIOPending_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
3992 PerlIOBuf_set_ptrcnt(aTHX_ f, ptr, cnt);
3997 PerlIOPending_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
3999 IV code = PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
4000 PerlIOl *l = PerlIOBase(f);
4002 * Our PerlIO_fast_gets must match what we are pushed on, or sv_gets()
4003 * etc. get muddled when it changes mid-string when we auto-pop.
4005 l->flags = (l->flags & ~(PERLIO_F_FASTGETS | PERLIO_F_UTF8)) |
4006 (PerlIOBase(PerlIONext(f))->
4007 flags & (PERLIO_F_FASTGETS | PERLIO_F_UTF8));
4012 PerlIOPending_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
4014 SSize_t avail = PerlIO_get_cnt(f);
4016 if ((SSize_t)count < avail)
4019 got = PerlIOBuf_read(aTHX_ f, vbuf, avail);
4020 if (got >= 0 && got < (SSize_t)count) {
4022 PerlIO_read(f, ((STDCHAR *) vbuf) + got, count - got);
4023 if (more >= 0 || got == 0)
4029 PERLIO_FUNCS_DECL(PerlIO_pending) = {
4030 sizeof(PerlIO_funcs),
4033 PERLIO_K_BUFFERED|PERLIO_K_RAW, /* not sure about RAW here */
4034 PerlIOPending_pushed,
4037 PerlIOBase_binmode, /* binmode */
4046 PerlIOPending_close,
4047 PerlIOPending_flush,
4051 PerlIOBase_clearerr,
4052 PerlIOBase_setlinebuf,
4057 PerlIOPending_set_ptrcnt,
4062 /*--------------------------------------------------------------------------------------*/
4064 * crlf - translation On read translate CR,LF to "\n" we do this by
4065 * overriding ptr/cnt entries to hand back a line at a time and keeping a
4066 * record of which nl we "lied" about. On write translate "\n" to CR,LF
4070 PerlIOBuf base; /* PerlIOBuf stuff */
4071 STDCHAR *nl; /* Position of crlf we "lied" about in the
4076 PerlIOCrlf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
4079 PerlIOBase(f)->flags |= PERLIO_F_CRLF;
4080 code = PerlIOBuf_pushed(aTHX_ f, mode, arg, tab);
4082 PerlIO_debug("PerlIOCrlf_pushed f=%p %s %s fl=%08" UVxf "\n",
4083 f, PerlIOBase(f)->tab->name, (mode) ? mode : "(Null)",
4084 PerlIOBase(f)->flags);
4087 /* Enable the first CRLF capable layer you can find, but if none
4088 * found, the one we just pushed is fine. This results in at
4089 * any given moment at most one CRLF-capable layer being enabled
4090 * in the whole layer stack. */
4091 PerlIO *g = PerlIONext(f);
4093 PerlIOl *b = PerlIOBase(g);
4094 if (b && b->tab == &PerlIO_crlf) {
4095 if (!(b->flags & PERLIO_F_CRLF))
4096 b->flags |= PERLIO_F_CRLF;
4097 PerlIO_pop(aTHX_ f);
4108 PerlIOCrlf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4110 PerlIOCrlf *c = PerlIOSelf(f, PerlIOCrlf);
4115 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF))
4116 return PerlIOBuf_unread(aTHX_ f, vbuf, count);
4118 const STDCHAR *buf = (const STDCHAR *) vbuf + count;
4119 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4121 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
4126 if (!(PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4127 b->end = b->ptr = b->buf + b->bufsiz;
4128 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4129 b->posn -= b->bufsiz;
4131 while (count > 0 && b->ptr > b->buf) {
4134 if (b->ptr - 2 >= b->buf) {
4157 PerlIOCrlf_get_cnt(pTHX_ PerlIO *f)
4159 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4162 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
4163 PerlIOCrlf *c = PerlIOSelf(f, PerlIOCrlf);
4164 if ((PerlIOBase(f)->flags & PERLIO_F_CRLF) && (!c->nl || *c->nl == 0xd)) {
4165 STDCHAR *nl = (c->nl) ? c->nl : b->ptr;
4167 while (nl < b->end && *nl != 0xd)
4169 if (nl < b->end && *nl == 0xd) {
4171 if (nl + 1 < b->end) {
4178 * Not CR,LF but just CR
4186 * Blast - found CR as last char in buffer
4191 * They may not care, defer work as long as
4195 return (nl - b->ptr);
4199 b->ptr++; /* say we have read it as far as
4200 * flush() is concerned */
4201 b->buf++; /* Leave space in front of buffer */
4202 /* Note as we have moved buf up flush's
4204 will naturally make posn point at CR
4206 b->bufsiz--; /* Buffer is thus smaller */
4207 code = PerlIO_fill(f); /* Fetch some more */
4208 b->bufsiz++; /* Restore size for next time */
4209 b->buf--; /* Point at space */
4210 b->ptr = nl = b->buf; /* Which is what we hand
4212 *nl = 0xd; /* Fill in the CR */
4214 goto test; /* fill() call worked */
4216 * CR at EOF - just fall through
4218 /* Should we clear EOF though ??? */
4223 return (((c->nl) ? (c->nl + 1) : b->end) - b->ptr);
4229 PerlIOCrlf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
4231 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4232 PerlIOCrlf *c = PerlIOSelf(f, PerlIOCrlf);
4238 if (ptr == b->end && *c->nl == 0xd) {
4239 /* Defered CR at end of buffer case - we lied about count */
4251 * Test code - delete when it works ...
4253 IV flags = PerlIOBase(f)->flags;
4254 STDCHAR *chk = (c->nl) ? (c->nl+1) : b->end;
4255 if (ptr+cnt == c->nl && c->nl+1 == b->end && *c->nl == 0xd) {
4256 /* Defered CR at end of buffer case - we lied about count */
4262 Perl_croak(aTHX_ "ptr wrong %p != %p fl=%08" UVxf
4263 " nl=%p e=%p for %d", ptr, chk, flags, c->nl,
4271 * They have taken what we lied about
4279 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4283 PerlIOCrlf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4285 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF))
4286 return PerlIOBuf_write(aTHX_ f, vbuf, count);
4288 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4289 const STDCHAR *buf = (const STDCHAR *) vbuf;
4290 const STDCHAR *ebuf = buf + count;
4293 if (!(PerlIOBase(f)->flags & PERLIO_F_CANWRITE))
4295 while (buf < ebuf) {
4296 STDCHAR *eptr = b->buf + b->bufsiz;
4297 PerlIOBase(f)->flags |= PERLIO_F_WRBUF;
4298 while (buf < ebuf && b->ptr < eptr) {
4300 if ((b->ptr + 2) > eptr) {
4308 *(b->ptr)++ = 0xd; /* CR */
4309 *(b->ptr)++ = 0xa; /* LF */
4311 if (PerlIOBase(f)->flags & PERLIO_F_LINEBUF) {
4321 if (b->ptr >= eptr) {
4327 if (PerlIOBase(f)->flags & PERLIO_F_UNBUF)
4329 return (buf - (STDCHAR *) vbuf);
4334 PerlIOCrlf_flush(pTHX_ PerlIO *f)
4336 PerlIOCrlf *c = PerlIOSelf(f, PerlIOCrlf);
4341 return PerlIOBuf_flush(aTHX_ f);
4345 PerlIOCrlf_binmode(pTHX_ PerlIO *f)
4347 if ((PerlIOBase(f)->flags & PERLIO_F_CRLF)) {
4348 /* In text mode - flush any pending stuff and flip it */
4349 PerlIOBase(f)->flags &= ~PERLIO_F_CRLF;
4350 #ifndef PERLIO_USING_CRLF
4351 /* CRLF is unusual case - if this is just the :crlf layer pop it */
4352 if (PerlIOBase(f)->tab == &PerlIO_crlf) {
4353 PerlIO_pop(aTHX_ f);
4360 PERLIO_FUNCS_DECL(PerlIO_crlf) = {
4361 sizeof(PerlIO_funcs),
4364 PERLIO_K_BUFFERED | PERLIO_K_CANCRLF | PERLIO_K_RAW,
4366 PerlIOBuf_popped, /* popped */
4368 PerlIOCrlf_binmode, /* binmode */
4372 PerlIOBuf_read, /* generic read works with ptr/cnt lies
4374 PerlIOCrlf_unread, /* Put CR,LF in buffer for each '\n' */
4375 PerlIOCrlf_write, /* Put CR,LF in buffer for each '\n' */
4383 PerlIOBase_clearerr,
4384 PerlIOBase_setlinebuf,
4389 PerlIOCrlf_set_ptrcnt,
4393 /*--------------------------------------------------------------------------------------*/
4395 * mmap as "buffer" layer
4399 PerlIOBuf base; /* PerlIOBuf stuff */
4400 Mmap_t mptr; /* Mapped address */
4401 Size_t len; /* mapped length */
4402 STDCHAR *bbuf; /* malloced buffer if map fails */
4406 PerlIOMmap_map(pTHX_ PerlIO *f)
4409 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4410 IV flags = PerlIOBase(f)->flags;
4414 if (flags & PERLIO_F_CANREAD) {
4415 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4416 int fd = PerlIO_fileno(f);
4418 code = Fstat(fd, &st);
4419 if (code == 0 && S_ISREG(st.st_mode)) {
4420 SSize_t len = st.st_size - b->posn;
4423 if (PL_mmap_page_size <= 0)
4424 Perl_croak(aTHX_ "panic: bad pagesize %" IVdf,
4428 * This is a hack - should never happen - open should
4431 b->posn = PerlIO_tell(PerlIONext(f));
4433 posn = (b->posn / PL_mmap_page_size) * PL_mmap_page_size;
4434 len = st.st_size - posn;
4435 m->mptr = mmap(NULL, len, PROT_READ, MAP_SHARED, fd, posn);
4436 if (m->mptr && m->mptr != (Mmap_t) - 1) {
4437 #if 0 && defined(HAS_MADVISE) && defined(MADV_SEQUENTIAL)
4438 madvise(m->mptr, len, MADV_SEQUENTIAL);
4440 #if 0 && defined(HAS_MADVISE) && defined(MADV_WILLNEED)
4441 madvise(m->mptr, len, MADV_WILLNEED);
4443 PerlIOBase(f)->flags =
4444 (flags & ~PERLIO_F_EOF) | PERLIO_F_RDBUF;
4445 b->end = ((STDCHAR *) m->mptr) + len;
4446 b->buf = ((STDCHAR *) m->mptr) + (b->posn - posn);
4455 PerlIOBase(f)->flags =
4456 flags | PERLIO_F_EOF | PERLIO_F_RDBUF;
4458 b->ptr = b->end = b->ptr;
4467 PerlIOMmap_unmap(pTHX_ PerlIO *f)
4469 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4470 PerlIOBuf *b = &m->base;
4474 code = munmap(m->mptr, m->len);
4478 if (PerlIO_seek(PerlIONext(f), b->posn, SEEK_SET) != 0)
4481 b->ptr = b->end = b->buf;
4482 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
4488 PerlIOMmap_get_base(pTHX_ PerlIO *f)
4490 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4491 PerlIOBuf *b = &m->base;
4492 if (b->buf && (PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4494 * Already have a readbuffer in progress
4500 * We have a write buffer or flushed PerlIOBuf read buffer
4502 m->bbuf = b->buf; /* save it in case we need it again */
4503 b->buf = NULL; /* Clear to trigger below */
4506 PerlIOMmap_map(aTHX_ f); /* Try and map it */
4509 * Map did not work - recover PerlIOBuf buffer if we have one
4514 b->ptr = b->end = b->buf;
4517 return PerlIOBuf_get_base(aTHX_ f);
4521 PerlIOMmap_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4523 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4524 PerlIOBuf *b = &m->base;
4525 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
4527 if (b->ptr && (b->ptr - count) >= b->buf
4528 && memEQ(b->ptr - count, vbuf, count)) {
4530 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
4535 * Loose the unwritable mapped buffer
4539 * If flush took the "buffer" see if we have one from before
4541 if (!b->buf && m->bbuf)
4544 PerlIOBuf_get_base(aTHX_ f);
4548 return PerlIOBuf_unread(aTHX_ f, vbuf, count);
4552 PerlIOMmap_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4554 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4555 PerlIOBuf *b = &m->base;
4556 if (!b->buf || !(PerlIOBase(f)->flags & PERLIO_F_WRBUF)) {
4558 * No, or wrong sort of, buffer
4561 if (PerlIOMmap_unmap(aTHX_ f) != 0)
4565 * If unmap took the "buffer" see if we have one from before
4567 if (!b->buf && m->bbuf)
4570 PerlIOBuf_get_base(aTHX_ f);
4574 return PerlIOBuf_write(aTHX_ f, vbuf, count);
4578 PerlIOMmap_flush(pTHX_ PerlIO *f)
4580 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4581 PerlIOBuf *b = &m->base;
4582 IV code = PerlIOBuf_flush(aTHX_ f);
4584 * Now we are "synced" at PerlIOBuf level
4591 if (PerlIOMmap_unmap(aTHX_ f) != 0)
4596 * We seem to have a PerlIOBuf buffer which was not mapped
4597 * remember it in case we need one later
4606 PerlIOMmap_fill(pTHX_ PerlIO *f)
4608 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4609 IV code = PerlIO_flush(f);
4610 if (code == 0 && !b->buf) {
4611 code = PerlIOMmap_map(aTHX_ f);
4613 if (code == 0 && !(PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4614 code = PerlIOBuf_fill(aTHX_ f);
4620 PerlIOMmap_close(pTHX_ PerlIO *f)
4622 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4623 PerlIOBuf *b = &m->base;
4624 IV code = PerlIO_flush(f);
4628 b->ptr = b->end = b->buf;
4630 if (PerlIOBuf_close(aTHX_ f) != 0)
4636 PerlIOMmap_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
4638 return PerlIOBase_dup(aTHX_ f, o, param, flags);
4642 PERLIO_FUNCS_DECL(PerlIO_mmap) = {
4643 sizeof(PerlIO_funcs),
4646 PERLIO_K_BUFFERED|PERLIO_K_RAW,
4650 PerlIOBase_binmode, /* binmode */
4664 PerlIOBase_clearerr,
4665 PerlIOBase_setlinebuf,
4666 PerlIOMmap_get_base,
4670 PerlIOBuf_set_ptrcnt,
4673 #endif /* HAS_MMAP */
4676 Perl_PerlIO_stdin(pTHX)
4679 PerlIO_stdstreams(aTHX);
4681 return &PL_perlio[1];
4685 Perl_PerlIO_stdout(pTHX)
4688 PerlIO_stdstreams(aTHX);
4690 return &PL_perlio[2];
4694 Perl_PerlIO_stderr(pTHX)
4697 PerlIO_stdstreams(aTHX);
4699 return &PL_perlio[3];
4702 /*--------------------------------------------------------------------------------------*/
4705 PerlIO_getname(PerlIO *f, char *buf)
4710 bool exported = FALSE;
4711 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
4713 stdio = PerlIO_exportFILE(f,0);
4717 name = fgetname(stdio, buf);
4718 if (exported) PerlIO_releaseFILE(f,stdio);
4724 Perl_croak(aTHX_ "Don't know how to get file name");
4730 /*--------------------------------------------------------------------------------------*/
4732 * Functions which can be called on any kind of PerlIO implemented in
4736 #undef PerlIO_fdopen
4738 PerlIO_fdopen(int fd, const char *mode)
4741 return PerlIO_openn(aTHX_ Nullch, mode, fd, 0, 0, NULL, 0, NULL);
4746 PerlIO_open(const char *path, const char *mode)
4749 SV *name = sv_2mortal(newSVpvn(path, strlen(path)));
4750 return PerlIO_openn(aTHX_ Nullch, mode, -1, 0, 0, NULL, 1, &name);
4753 #undef Perlio_reopen
4755 PerlIO_reopen(const char *path, const char *mode, PerlIO *f)
4758 SV *name = sv_2mortal(newSVpvn(path, strlen(path)));
4759 return PerlIO_openn(aTHX_ Nullch, mode, -1, 0, 0, f, 1, &name);
4764 PerlIO_getc(PerlIO *f)
4768 SSize_t count = PerlIO_read(f, buf, 1);
4770 return (unsigned char) buf[0];
4775 #undef PerlIO_ungetc
4777 PerlIO_ungetc(PerlIO *f, int ch)
4782 if (PerlIO_unread(f, &buf, 1) == 1)
4790 PerlIO_putc(PerlIO *f, int ch)
4794 return PerlIO_write(f, &buf, 1);
4799 PerlIO_puts(PerlIO *f, const char *s)
4802 STRLEN len = strlen(s);
4803 return PerlIO_write(f, s, len);
4806 #undef PerlIO_rewind
4808 PerlIO_rewind(PerlIO *f)
4811 PerlIO_seek(f, (Off_t) 0, SEEK_SET);
4815 #undef PerlIO_vprintf
4817 PerlIO_vprintf(PerlIO *f, const char *fmt, va_list ap)
4820 SV *sv = newSVpvn("", 0);
4826 Perl_va_copy(ap, apc);
4827 sv_vcatpvf(sv, fmt, &apc);
4829 sv_vcatpvf(sv, fmt, &ap);
4832 wrote = PerlIO_write(f, s, len);
4837 #undef PerlIO_printf
4839 PerlIO_printf(PerlIO *f, const char *fmt, ...)
4844 result = PerlIO_vprintf(f, fmt, ap);
4849 #undef PerlIO_stdoutf
4851 PerlIO_stdoutf(const char *fmt, ...)
4857 result = PerlIO_vprintf(PerlIO_stdout(), fmt, ap);
4862 #undef PerlIO_tmpfile
4864 PerlIO_tmpfile(void)
4869 int fd = win32_tmpfd();
4871 f = PerlIO_fdopen(fd, "w+b");
4873 # if defined(HAS_MKSTEMP) && ! defined(VMS) && ! defined(OS2)
4874 SV *sv = newSVpv("/tmp/PerlIO_XXXXXX", 0);
4876 * I have no idea how portable mkstemp() is ... NI-S
4878 int fd = mkstemp(SvPVX(sv));
4880 f = PerlIO_fdopen(fd, "w+");
4882 PerlIOBase(f)->flags |= PERLIO_F_TEMP;
4883 PerlLIO_unlink(SvPVX(sv));
4886 # else /* !HAS_MKSTEMP, fallback to stdio tmpfile(). */
4887 FILE *stdio = PerlSIO_tmpfile();
4890 if ((f = PerlIO_push(aTHX_(PerlIO_allocate(aTHX)),
4891 PERLIO_FUNCS_CAST(&PerlIO_stdio),
4893 PerlIOStdio *s = PerlIOSelf(f, PerlIOStdio);
4899 # endif /* else HAS_MKSTEMP */
4900 #endif /* else WIN32 */
4907 #endif /* USE_SFIO */
4908 #endif /* PERLIO_IS_STDIO */
4910 /*======================================================================================*/
4912 * Now some functions in terms of above which may be needed even if we are
4913 * not in true PerlIO mode
4917 #undef PerlIO_setpos
4919 PerlIO_setpos(PerlIO *f, SV *pos)
4924 Off_t *posn = (Off_t *) SvPV(pos, len);
4925 if (f && len == sizeof(Off_t))
4926 return PerlIO_seek(f, *posn, SEEK_SET);
4928 SETERRNO(EINVAL, SS_IVCHAN);
4932 #undef PerlIO_setpos
4934 PerlIO_setpos(PerlIO *f, SV *pos)
4939 Fpos_t *fpos = (Fpos_t *) SvPV(pos, len);
4940 if (f && len == sizeof(Fpos_t)) {
4941 #if defined(USE_64_BIT_STDIO) && defined(USE_FSETPOS64)
4942 return fsetpos64(f, fpos);
4944 return fsetpos(f, fpos);
4948 SETERRNO(EINVAL, SS_IVCHAN);
4954 #undef PerlIO_getpos
4956 PerlIO_getpos(PerlIO *f, SV *pos)
4959 Off_t posn = PerlIO_tell(f);
4960 sv_setpvn(pos, (char *) &posn, sizeof(posn));
4961 return (posn == (Off_t) - 1) ? -1 : 0;
4964 #undef PerlIO_getpos
4966 PerlIO_getpos(PerlIO *f, SV *pos)
4971 #if defined(USE_64_BIT_STDIO) && defined(USE_FSETPOS64)
4972 code = fgetpos64(f, &fpos);
4974 code = fgetpos(f, &fpos);
4976 sv_setpvn(pos, (char *) &fpos, sizeof(fpos));
4981 #if (defined(PERLIO_IS_STDIO) || !defined(USE_SFIO)) && !defined(HAS_VPRINTF)
4984 vprintf(char *pat, char *args)
4986 _doprnt(pat, args, stdout);
4987 return 0; /* wrong, but perl doesn't use the return
4992 vfprintf(FILE *fd, char *pat, char *args)
4994 _doprnt(pat, args, fd);
4995 return 0; /* wrong, but perl doesn't use the return
5001 #ifndef PerlIO_vsprintf
5003 PerlIO_vsprintf(char *s, int n, const char *fmt, va_list ap)
5006 int val = vsprintf(s, fmt, ap);
5008 if (strlen(s) >= (STRLEN) n) {
5010 (void) PerlIO_puts(Perl_error_log,
5011 "panic: sprintf overflow - memory corrupted!\n");
5019 #ifndef PerlIO_sprintf
5021 PerlIO_sprintf(char *s, int n, const char *fmt, ...)
5026 result = PerlIO_vsprintf(s, n, fmt, ap);