2 * perlio.c Copyright (c) 1996-2004, 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
60 /* Missing proto on LynxOS */
64 /* Call the callback or PerlIOBase, and return failure. */
65 #define Perl_PerlIO_or_Base(f, callback, base, failure, args) \
66 if (PerlIOValid(f)) { \
67 PerlIO_funcs *tab = PerlIOBase(f)->tab; \
68 if (tab && tab->callback) \
69 return (*tab->callback) args; \
71 return PerlIOBase_ ## base args; \
74 SETERRNO(EBADF, SS_IVCHAN); \
77 /* Call the callback or fail, and return failure. */
78 #define Perl_PerlIO_or_fail(f, callback, failure, args) \
79 if (PerlIOValid(f)) { \
80 PerlIO_funcs *tab = PerlIOBase(f)->tab; \
81 if (tab && tab->callback) \
82 return (*tab->callback) args; \
83 SETERRNO(EINVAL, LIB_INVARG); \
86 SETERRNO(EBADF, SS_IVCHAN); \
89 /* Call the callback or PerlIOBase, and be void. */
90 #define Perl_PerlIO_or_Base_void(f, callback, base, args) \
91 if (PerlIOValid(f)) { \
92 PerlIO_funcs *tab = PerlIOBase(f)->tab; \
93 if (tab && tab->callback) \
94 (*tab->callback) args; \
96 PerlIOBase_ ## base args; \
99 SETERRNO(EBADF, SS_IVCHAN)
101 /* Call the callback or fail, and be void. */
102 #define Perl_PerlIO_or_fail_void(f, callback, args) \
103 if (PerlIOValid(f)) { \
104 PerlIO_funcs *tab = PerlIOBase(f)->tab; \
105 if (tab && tab->callback) \
106 (*tab->callback) args; \
108 SETERRNO(EINVAL, LIB_INVARG); \
111 SETERRNO(EBADF, SS_IVCHAN)
114 perlsio_binmode(FILE *fp, int iotype, int mode)
117 * This used to be contents of do_binmode in doio.c
120 # if defined(atarist) || defined(__MINT__)
123 ((FILE *) fp)->_flag |= _IOBIN;
125 ((FILE *) fp)->_flag &= ~_IOBIN;
132 if (PerlLIO_setmode(fp, mode) != -1) {
134 if (PerlLIO_setmode(fileno(fp), mode) != -1) {
136 # if defined(WIN32) && defined(__BORLANDC__)
138 * The translation mode of the stream is maintained independent of
139 * the translation mode of the fd in the Borland RTL (heavy
140 * digging through their runtime sources reveal). User has to set
141 * the mode explicitly for the stream (though they don't document
142 * this anywhere). GSAR 97-5-24
148 fp->flags &= ~_F_BIN;
156 # if defined(USEMYBINMODE)
158 if (my_binmode(fp, iotype, mode) != FALSE)
169 #define O_ACCMODE 3 /* Assume traditional implementation */
173 PerlIO_intmode2str(int rawmode, char *mode, int *writing)
175 int result = rawmode & O_ACCMODE;
180 ptype = IoTYPE_RDONLY;
183 ptype = IoTYPE_WRONLY;
191 *writing = (result != O_RDONLY);
193 if (result == O_RDONLY) {
197 else if (rawmode & O_APPEND) {
199 if (result != O_WRONLY)
204 if (result == O_WRONLY)
211 if (rawmode & O_BINARY)
217 #ifndef PERLIO_LAYERS
219 PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode, const char *names)
221 if (!names || !*names
222 || strEQ(names, ":crlf")
223 || strEQ(names, ":raw")
224 || strEQ(names, ":bytes")
228 Perl_croak(aTHX_ "Cannot apply \"%s\" in non-PerlIO perl", names);
236 PerlIO_destruct(pTHX)
241 PerlIO_binmode(pTHX_ PerlIO *fp, int iotype, int mode, const char *names)
246 return perlsio_binmode(fp, iotype, mode);
251 PerlIO_fdupopen(pTHX_ PerlIO *f, CLONE_PARAMS *param, int flags)
256 #ifdef PERL_IMPLICIT_SYS
257 return PerlSIO_fdupopen(f);
260 return win32_fdupopen(f);
263 int fd = PerlLIO_dup(PerlIO_fileno(f));
266 int omode = fcntl(fd, F_GETFL);
268 omode = djgpp_get_stream_mode(f);
270 PerlIO_intmode2str(omode,mode,NULL);
271 /* the r+ is a hack */
272 return PerlIO_fdopen(fd, mode);
277 SETERRNO(EBADF, SS_IVCHAN);
287 * De-mux PerlIO_openn() into fdopen, freopen and fopen type entries
291 PerlIO_openn(pTHX_ const char *layers, const char *mode, int fd,
292 int imode, int perm, PerlIO *old, int narg, SV **args)
296 Perl_croak(aTHX_ "More than one argument to open");
298 if (*args == &PL_sv_undef)
299 return PerlIO_tmpfile();
301 char *name = SvPV_nolen(*args);
302 if (*mode == IoTYPE_NUMERIC) {
303 fd = PerlLIO_open3(name, imode, perm);
305 return PerlIO_fdopen(fd, (char *) mode + 1);
308 return PerlIO_reopen(name, mode, old);
311 return PerlIO_open(name, mode);
316 return PerlIO_fdopen(fd, (char *) mode);
321 XS(XS_PerlIO__Layer__find)
325 Perl_croak(aTHX_ "Usage class->find(name[,load])");
327 char *name = SvPV_nolen(ST(1));
328 ST(0) = (strEQ(name, "crlf")
329 || strEQ(name, "raw")) ? &PL_sv_yes : &PL_sv_undef;
336 Perl_boot_core_PerlIO(pTHX)
338 newXS("PerlIO::Layer::find", XS_PerlIO__Layer__find, __FILE__);
344 #ifdef PERLIO_IS_STDIO
350 * Does nothing (yet) except force this file to be included in perl
351 * binary. That allows this file to force inclusion of other functions
352 * that may be required by loadable extensions e.g. for
353 * FileHandle::tmpfile
357 #undef PerlIO_tmpfile
364 #else /* PERLIO_IS_STDIO */
372 * This section is just to make sure these functions get pulled in from
376 #undef PerlIO_tmpfile
387 * Force this file to be included in perl binary. Which allows this
388 * file to force inclusion of other functions that may be required by
389 * loadable extensions e.g. for FileHandle::tmpfile
393 * Hack sfio does its own 'autoflush' on stdout in common cases. Flush
394 * results in a lot of lseek()s to regular files and lot of small
397 sfset(sfstdout, SF_SHARE, 0);
400 /* This is not the reverse of PerlIO_exportFILE(), PerlIO_releaseFILE() is. */
402 PerlIO_importFILE(FILE *stdio, const char *mode)
404 int fd = fileno(stdio);
405 if (!mode || !*mode) {
408 return PerlIO_fdopen(fd, mode);
412 PerlIO_findFILE(PerlIO *pio)
414 int fd = PerlIO_fileno(pio);
415 FILE *f = fdopen(fd, "r+");
417 if (!f && errno == EINVAL)
419 if (!f && errno == EINVAL)
426 /*======================================================================================*/
428 * Implement all the PerlIO interface ourselves.
434 * We _MUST_ have <unistd.h> if we are using lseek() and may have large
441 #include <sys/mman.h>
445 * Why is this here - not in perlio.h? RMB
447 void PerlIO_debug(const char *fmt, ...)
448 __attribute__format__(__printf__, 1, 2);
451 PerlIO_debug(const char *fmt, ...)
458 char *s = PerlEnv_getenv("PERLIO_DEBUG");
460 dbg = PerlLIO_open3(s, O_WRONLY | O_CREAT | O_APPEND, 0666);
467 /* Use fixed buffer as sv_catpvf etc. needs SVs */
471 s = CopFILE(PL_curcop);
474 sprintf(buffer, "%s:%" IVdf " ", s, (IV) CopLINE(PL_curcop));
475 len = strlen(buffer);
476 vsprintf(buffer+len, fmt, ap);
477 PerlLIO_write(dbg, buffer, strlen(buffer));
479 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(dbg, 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)) {
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)
745 if ((SSize_t) len <= 0)
747 for (i = 0; i < PL_known_layers->cur; i++) {
748 PerlIO_funcs *f = PL_known_layers->array[i].funcs;
749 if (memEQ(f->name, name, len) && f->name[len] == 0) {
750 PerlIO_debug("%.*s => %p\n", (int) len, name, (void*)f);
754 if (load && PL_subname && PL_def_layerlist
755 && PL_def_layerlist->cur >= 2) {
756 if (PL_in_load_module) {
757 Perl_croak(aTHX_ "Recursive call to Perl_load_module in PerlIO_find_layer");
760 SV *pkgsv = newSVpvn("PerlIO", 6);
761 SV *layer = newSVpvn(name, len);
762 CV *cv = get_cv("PerlIO::Layer::NoWarnings", FALSE);
764 SAVEINT(PL_in_load_module);
766 SAVESPTR(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 char *name = SvPV(ST(1), len);
890 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 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 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 *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)
1039 if (PerlIOValid(f)) {
1041 PerlIO_pop(aTHX_ f);
1047 PerlIO_funcs PerlIO_remove = {
1048 sizeof(PerlIO_funcs),
1051 PERLIO_K_DUMMY | PERLIO_K_UTF8,
1069 NULL, /* get_base */
1070 NULL, /* get_bufsiz */
1073 NULL, /* set_ptrcnt */
1077 PerlIO_default_layers(pTHX)
1079 if (!PL_def_layerlist) {
1080 const char *s = (PL_tainting) ? Nullch : PerlEnv_getenv("PERLIO");
1081 PerlIO_funcs *osLayer = &PerlIO_unix;
1082 PL_def_layerlist = PerlIO_list_alloc(aTHX);
1083 PerlIO_define_layer(aTHX_ & PerlIO_unix);
1085 PerlIO_define_layer(aTHX_ & PerlIO_win32);
1087 osLayer = &PerlIO_win32;
1090 PerlIO_define_layer(aTHX_ & PerlIO_raw);
1091 PerlIO_define_layer(aTHX_ & PerlIO_perlio);
1092 PerlIO_define_layer(aTHX_ & PerlIO_stdio);
1093 PerlIO_define_layer(aTHX_ & PerlIO_crlf);
1095 PerlIO_define_layer(aTHX_ & PerlIO_mmap);
1097 PerlIO_define_layer(aTHX_ & PerlIO_utf8);
1098 PerlIO_define_layer(aTHX_ & PerlIO_remove);
1099 PerlIO_define_layer(aTHX_ & PerlIO_byte);
1100 PerlIO_list_push(aTHX_ PL_def_layerlist,
1101 PerlIO_find_layer(aTHX_ osLayer->name, 0, 0),
1104 PerlIO_parse_layers(aTHX_ PL_def_layerlist, s);
1107 PerlIO_default_buffer(aTHX_ PL_def_layerlist);
1110 if (PL_def_layerlist->cur < 2) {
1111 PerlIO_default_buffer(aTHX_ PL_def_layerlist);
1113 return PL_def_layerlist;
1117 Perl_boot_core_PerlIO(pTHX)
1119 #ifdef USE_ATTRIBUTES_FOR_PERLIO
1120 newXS("io::MODIFY_SCALAR_ATTRIBUTES", XS_io_MODIFY_SCALAR_ATTRIBUTES,
1123 newXS("PerlIO::Layer::find", XS_PerlIO__Layer__find, __FILE__);
1124 newXS("PerlIO::Layer::NoWarnings", XS_PerlIO__Layer__NoWarnings, __FILE__);
1128 PerlIO_default_layer(pTHX_ I32 n)
1130 PerlIO_list_t *av = PerlIO_default_layers(aTHX);
1133 return PerlIO_layer_fetch(aTHX_ av, n, &PerlIO_stdio);
1136 #define PerlIO_default_top() PerlIO_default_layer(aTHX_ -1)
1137 #define PerlIO_default_btm() PerlIO_default_layer(aTHX_ 0)
1140 PerlIO_stdstreams(pTHX)
1143 PerlIO_allocate(aTHX);
1144 PerlIO_fdopen(0, "Ir" PERLIO_STDTEXT);
1145 PerlIO_fdopen(1, "Iw" PERLIO_STDTEXT);
1146 PerlIO_fdopen(2, "Iw" PERLIO_STDTEXT);
1151 PerlIO_push(pTHX_ PerlIO *f, PerlIO_funcs *tab, const char *mode, SV *arg)
1153 if (tab->fsize != sizeof(PerlIO_funcs)) {
1155 Perl_croak(aTHX_ "Layer does not match this perl");
1159 if (tab->size < sizeof(PerlIOl)) {
1162 /* Real layer with a data area */
1163 Newc('L',l,tab->size,char,PerlIOl);
1165 Zero(l, tab->size, char);
1169 PerlIO_debug("PerlIO_push f=%p %s %s %p\n", (void*)f, tab->name,
1170 (mode) ? mode : "(Null)", (void*)arg);
1171 if (*l->tab->Pushed &&
1172 (*l->tab->Pushed) (aTHX_ f, mode, arg, tab) != 0) {
1173 PerlIO_pop(aTHX_ f);
1179 /* Pseudo-layer where push does its own stack adjust */
1180 PerlIO_debug("PerlIO_push f=%p %s %s %p\n", (void*)f, tab->name,
1181 (mode) ? mode : "(Null)", (void*)arg);
1183 (*tab->Pushed) (aTHX_ f, mode, arg, tab) != 0) {
1191 PerlIOBase_binmode(pTHX_ PerlIO *f)
1193 if (PerlIOValid(f)) {
1194 /* Is layer suitable for raw stream ? */
1195 if (PerlIOBase(f)->tab->kind & PERLIO_K_RAW) {
1196 /* Yes - turn off UTF-8-ness, to undo UTF-8 locale effects */
1197 PerlIOBase(f)->flags &= ~PERLIO_F_UTF8;
1200 /* Not suitable - pop it */
1201 PerlIO_pop(aTHX_ f);
1209 PerlIORaw_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1212 if (PerlIOValid(f)) {
1217 * Strip all layers that are not suitable for a raw stream
1220 while (t && (l = *t)) {
1221 if (l->tab->Binmode) {
1222 /* Has a handler - normal case */
1223 if ((*l->tab->Binmode)(aTHX_ f) == 0) {
1225 /* Layer still there - move down a layer */
1234 /* No handler - pop it */
1235 PerlIO_pop(aTHX_ t);
1238 if (PerlIOValid(f)) {
1239 PerlIO_debug(":raw f=%p :%s\n", (void*)f, PerlIOBase(f)->tab->name);
1247 PerlIO_apply_layera(pTHX_ PerlIO *f, const char *mode,
1248 PerlIO_list_t *layers, IV n, IV max)
1252 PerlIO_funcs *tab = PerlIO_layer_fetch(aTHX_ layers, n, NULL);
1254 if (!PerlIO_push(aTHX_ f, tab, mode, PerlIOArg)) {
1265 PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode, const char *names)
1269 PerlIO_list_t *layers = PerlIO_list_alloc(aTHX);
1270 code = PerlIO_parse_layers(aTHX_ layers, names);
1272 code = PerlIO_apply_layera(aTHX_ f, mode, layers, 0, layers->cur);
1274 PerlIO_list_free(aTHX_ layers);
1280 /*--------------------------------------------------------------------------------------*/
1282 * Given the abstraction above the public API functions
1286 PerlIO_binmode(pTHX_ PerlIO *f, int iotype, int mode, const char *names)
1288 PerlIO_debug("PerlIO_binmode f=%p %s %c %x %s\n",
1289 (void*)f, PerlIOBase(f)->tab->name, iotype, mode,
1290 (names) ? names : "(Null)");
1292 /* Do not flush etc. if (e.g.) switching encodings.
1293 if a pushed layer knows it needs to flush lower layers
1294 (for example :unix which is never going to call them)
1295 it can do the flush when it is pushed.
1297 return PerlIO_apply_layers(aTHX_ f, NULL, names) == 0 ? TRUE : FALSE;
1300 /* Fake 5.6 legacy of using this call to turn ON O_TEXT */
1301 #ifdef PERLIO_USING_CRLF
1302 /* Legacy binmode only has meaning if O_TEXT has a value distinct from
1303 O_BINARY so we can look for it in mode.
1305 if (!(mode & O_BINARY)) {
1307 /* FIXME?: Looking down the layer stack seems wrong,
1308 but is a way of reaching past (say) an encoding layer
1309 to flip CRLF-ness of the layer(s) below
1312 /* Perhaps we should turn on bottom-most aware layer
1313 e.g. Ilya's idea that UNIX TTY could serve
1315 if (PerlIOBase(f)->tab->kind & PERLIO_K_CANCRLF) {
1316 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF)) {
1317 /* Not in text mode - flush any pending stuff and flip it */
1319 PerlIOBase(f)->flags |= PERLIO_F_CRLF;
1321 /* Only need to turn it on in one layer so we are done */
1326 /* Not finding a CRLF aware layer presumably means we are binary
1327 which is not what was requested - so we failed
1328 We _could_ push :crlf layer but so could caller
1333 /* Legacy binmode is now _defined_ as being equivalent to pushing :raw
1334 So code that used to be here is now in PerlIORaw_pushed().
1336 return PerlIO_push(aTHX_ f, &PerlIO_raw, Nullch, Nullsv) ? TRUE : FALSE;
1341 PerlIO__close(pTHX_ PerlIO *f)
1343 if (PerlIOValid(f)) {
1344 PerlIO_funcs *tab = PerlIOBase(f)->tab;
1345 if (tab && tab->Close)
1346 return (*tab->Close)(aTHX_ f);
1348 return PerlIOBase_close(aTHX_ f);
1351 SETERRNO(EBADF, SS_IVCHAN);
1357 Perl_PerlIO_close(pTHX_ PerlIO *f)
1359 int code = PerlIO__close(aTHX_ f);
1360 while (PerlIOValid(f)) {
1361 PerlIO_pop(aTHX_ f);
1367 Perl_PerlIO_fileno(pTHX_ PerlIO *f)
1369 Perl_PerlIO_or_Base(f, Fileno, fileno, -1, (aTHX_ f));
1373 PerlIO_context_layers(pTHX_ const char *mode)
1375 const char *type = NULL;
1377 * Need to supply default layer info from open.pm
1380 SV *layers = PL_curcop->cop_io;
1383 type = SvPV(layers, len);
1384 if (type && mode[0] != 'r') {
1386 * Skip to write part
1388 const char *s = strchr(type, 0);
1389 if (s && (STRLEN)(s - type) < len) {
1398 static PerlIO_funcs *
1399 PerlIO_layer_from_ref(pTHX_ SV *sv)
1402 * For any scalar type load the handler which is bundled with perl
1404 if (SvTYPE(sv) < SVt_PVAV)
1405 return PerlIO_find_layer(aTHX_ "scalar", 6, 1);
1408 * For other types allow if layer is known but don't try and load it
1410 switch (SvTYPE(sv)) {
1412 return PerlIO_find_layer(aTHX_ "Array", 5, 0);
1414 return PerlIO_find_layer(aTHX_ "Hash", 4, 0);
1416 return PerlIO_find_layer(aTHX_ "Code", 4, 0);
1418 return PerlIO_find_layer(aTHX_ "Glob", 4, 0);
1424 PerlIO_resolve_layers(pTHX_ const char *layers,
1425 const char *mode, int narg, SV **args)
1427 PerlIO_list_t *def = PerlIO_default_layers(aTHX);
1430 PerlIO_stdstreams(aTHX);
1434 * If it is a reference but not an object see if we have a handler
1437 if (SvROK(arg) && !sv_isobject(arg)) {
1438 PerlIO_funcs *handler = PerlIO_layer_from_ref(aTHX_ SvRV(arg));
1440 def = PerlIO_list_alloc(aTHX);
1441 PerlIO_list_push(aTHX_ def, handler, &PL_sv_undef);
1445 * Don't fail if handler cannot be found :via(...) etc. may do
1446 * something sensible else we will just stringfy and open
1452 layers = PerlIO_context_layers(aTHX_ mode);
1453 if (layers && *layers) {
1457 av = PerlIO_list_alloc(aTHX);
1458 for (i = 0; i < def->cur; i++) {
1459 PerlIO_list_push(aTHX_ av, def->array[i].funcs,
1466 if (PerlIO_parse_layers(aTHX_ av, layers) == 0) {
1470 PerlIO_list_free(aTHX_ av);
1471 return (PerlIO_list_t *) NULL;
1482 PerlIO_openn(pTHX_ const char *layers, const char *mode, int fd,
1483 int imode, int perm, PerlIO *f, int narg, SV **args)
1485 if (!f && narg == 1 && *args == &PL_sv_undef) {
1486 if ((f = PerlIO_tmpfile())) {
1488 layers = PerlIO_context_layers(aTHX_ mode);
1489 if (layers && *layers)
1490 PerlIO_apply_layers(aTHX_ f, mode, layers);
1494 PerlIO_list_t *layera = NULL;
1496 PerlIO_funcs *tab = NULL;
1497 if (PerlIOValid(f)) {
1499 * This is "reopen" - it is not tested as perl does not use it
1503 layera = PerlIO_list_alloc(aTHX);
1505 SV *arg = (l->tab->Getarg)
1506 ? (*l->tab->Getarg) (aTHX_ &l, NULL, 0)
1508 PerlIO_list_push(aTHX_ layera, l->tab, arg);
1509 l = *PerlIONext(&l);
1513 layera = PerlIO_resolve_layers(aTHX_ layers, mode, narg, args);
1519 * Start at "top" of layer stack
1521 n = layera->cur - 1;
1523 PerlIO_funcs *t = PerlIO_layer_fetch(aTHX_ layera, n, NULL);
1532 * Found that layer 'n' can do opens - call it
1534 if (narg > 1 && !(tab->kind & PERLIO_K_MULTIARG)) {
1535 Perl_croak(aTHX_ "More than one argument to open(,':%s')",tab->name);
1537 PerlIO_debug("openn(%s,'%s','%s',%d,%x,%o,%p,%d,%p)\n",
1538 tab->name, layers, mode, fd, imode, perm,
1539 (void*)f, narg, (void*)args);
1541 f = (*tab->Open) (aTHX_ tab, layera, n, mode, fd, imode, perm,
1544 SETERRNO(EINVAL, LIB_INVARG);
1548 if (n + 1 < layera->cur) {
1550 * More layers above the one that we used to open -
1553 if (PerlIO_apply_layera(aTHX_ f, mode, layera, n + 1, layera->cur) != 0) {
1554 /* If pushing layers fails close the file */
1561 PerlIO_list_free(aTHX_ layera);
1568 Perl_PerlIO_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
1570 Perl_PerlIO_or_Base(f, Read, read, -1, (aTHX_ f, vbuf, count));
1574 Perl_PerlIO_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
1576 Perl_PerlIO_or_Base(f, Unread, unread, -1, (aTHX_ f, vbuf, count));
1580 Perl_PerlIO_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
1582 Perl_PerlIO_or_fail(f, Write, -1, (aTHX_ f, vbuf, count));
1586 Perl_PerlIO_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
1588 Perl_PerlIO_or_fail(f, Seek, -1, (aTHX_ f, offset, whence));
1592 Perl_PerlIO_tell(pTHX_ PerlIO *f)
1594 Perl_PerlIO_or_fail(f, Tell, -1, (aTHX_ f));
1598 Perl_PerlIO_flush(pTHX_ PerlIO *f)
1602 PerlIO_funcs *tab = PerlIOBase(f)->tab;
1604 if (tab && tab->Flush)
1605 return (*tab->Flush) (aTHX_ f);
1607 return 0; /* If no Flush defined, silently succeed. */
1610 PerlIO_debug("Cannot flush f=%p\n", (void*)f);
1611 SETERRNO(EBADF, SS_IVCHAN);
1617 * Is it good API design to do flush-all on NULL, a potentially
1618 * errorneous input? Maybe some magical value (PerlIO*
1619 * PERLIO_FLUSH_ALL = (PerlIO*)-1;)? Yes, stdio does similar
1620 * things on fflush(NULL), but should we be bound by their design
1623 PerlIO **table = &PL_perlio;
1625 while ((f = *table)) {
1627 table = (PerlIO **) (f++);
1628 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
1629 if (*f && PerlIO_flush(f) != 0)
1639 PerlIOBase_flush_linebuf(pTHX)
1641 PerlIO **table = &PL_perlio;
1643 while ((f = *table)) {
1645 table = (PerlIO **) (f++);
1646 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
1649 flags & (PERLIO_F_LINEBUF | PERLIO_F_CANWRITE))
1650 == (PERLIO_F_LINEBUF | PERLIO_F_CANWRITE))
1658 Perl_PerlIO_fill(pTHX_ PerlIO *f)
1660 Perl_PerlIO_or_fail(f, Fill, -1, (aTHX_ f));
1664 PerlIO_isutf8(PerlIO *f)
1667 return (PerlIOBase(f)->flags & PERLIO_F_UTF8) != 0;
1669 SETERRNO(EBADF, SS_IVCHAN);
1675 Perl_PerlIO_eof(pTHX_ PerlIO *f)
1677 Perl_PerlIO_or_Base(f, Eof, eof, -1, (aTHX_ f));
1681 Perl_PerlIO_error(pTHX_ PerlIO *f)
1683 Perl_PerlIO_or_Base(f, Error, error, -1, (aTHX_ f));
1687 Perl_PerlIO_clearerr(pTHX_ PerlIO *f)
1689 Perl_PerlIO_or_Base_void(f, Clearerr, clearerr, (aTHX_ f));
1693 Perl_PerlIO_setlinebuf(pTHX_ PerlIO *f)
1695 Perl_PerlIO_or_Base_void(f, Setlinebuf, setlinebuf, (aTHX_ f));
1699 PerlIO_has_base(PerlIO *f)
1701 if (PerlIOValid(f)) {
1702 PerlIO_funcs *tab = PerlIOBase(f)->tab;
1705 return (tab->Get_base != NULL);
1706 SETERRNO(EINVAL, LIB_INVARG);
1709 SETERRNO(EBADF, SS_IVCHAN);
1715 PerlIO_fast_gets(PerlIO *f)
1717 if (PerlIOValid(f) && (PerlIOBase(f)->flags & PERLIO_F_FASTGETS)) {
1718 PerlIO_funcs *tab = PerlIOBase(f)->tab;
1721 return (tab->Set_ptrcnt != NULL);
1722 SETERRNO(EINVAL, LIB_INVARG);
1725 SETERRNO(EBADF, SS_IVCHAN);
1731 PerlIO_has_cntptr(PerlIO *f)
1733 if (PerlIOValid(f)) {
1734 PerlIO_funcs *tab = PerlIOBase(f)->tab;
1737 return (tab->Get_ptr != NULL && tab->Get_cnt != NULL);
1738 SETERRNO(EINVAL, LIB_INVARG);
1741 SETERRNO(EBADF, SS_IVCHAN);
1747 PerlIO_canset_cnt(PerlIO *f)
1749 if (PerlIOValid(f)) {
1750 PerlIO_funcs *tab = PerlIOBase(f)->tab;
1753 return (tab->Set_ptrcnt != NULL);
1754 SETERRNO(EINVAL, LIB_INVARG);
1757 SETERRNO(EBADF, SS_IVCHAN);
1763 Perl_PerlIO_get_base(pTHX_ PerlIO *f)
1765 Perl_PerlIO_or_fail(f, Get_base, NULL, (aTHX_ f));
1769 Perl_PerlIO_get_bufsiz(pTHX_ PerlIO *f)
1771 Perl_PerlIO_or_fail(f, Get_bufsiz, -1, (aTHX_ f));
1775 Perl_PerlIO_get_ptr(pTHX_ PerlIO *f)
1777 Perl_PerlIO_or_fail(f, Get_ptr, NULL, (aTHX_ f));
1781 Perl_PerlIO_get_cnt(pTHX_ PerlIO *f)
1783 Perl_PerlIO_or_fail(f, Get_cnt, -1, (aTHX_ f));
1787 Perl_PerlIO_set_cnt(pTHX_ PerlIO *f, int cnt)
1789 Perl_PerlIO_or_fail_void(f, Set_ptrcnt, (aTHX_ f, NULL, cnt));
1793 Perl_PerlIO_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, int cnt)
1795 Perl_PerlIO_or_fail_void(f, Set_ptrcnt, (aTHX_ f, ptr, cnt));
1799 /*--------------------------------------------------------------------------------------*/
1801 * utf8 and raw dummy layers
1805 PerlIOUtf8_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1807 if (PerlIOValid(f)) {
1808 if (tab->kind & PERLIO_K_UTF8)
1809 PerlIOBase(f)->flags |= PERLIO_F_UTF8;
1811 PerlIOBase(f)->flags &= ~PERLIO_F_UTF8;
1817 PerlIO_funcs PerlIO_utf8 = {
1818 sizeof(PerlIO_funcs),
1821 PERLIO_K_DUMMY | PERLIO_K_UTF8,
1839 NULL, /* get_base */
1840 NULL, /* get_bufsiz */
1843 NULL, /* set_ptrcnt */
1846 PerlIO_funcs PerlIO_byte = {
1847 sizeof(PerlIO_funcs),
1868 NULL, /* get_base */
1869 NULL, /* get_bufsiz */
1872 NULL, /* set_ptrcnt */
1876 PerlIORaw_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
1877 IV n, const char *mode, int fd, int imode, int perm,
1878 PerlIO *old, int narg, SV **args)
1880 PerlIO_funcs *tab = PerlIO_default_btm();
1881 if (tab && tab->Open)
1882 return (*tab->Open) (aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
1884 SETERRNO(EINVAL, LIB_INVARG);
1888 PerlIO_funcs PerlIO_raw = {
1889 sizeof(PerlIO_funcs),
1910 NULL, /* get_base */
1911 NULL, /* get_bufsiz */
1914 NULL, /* set_ptrcnt */
1916 /*--------------------------------------------------------------------------------------*/
1917 /*--------------------------------------------------------------------------------------*/
1919 * "Methods" of the "base class"
1923 PerlIOBase_fileno(pTHX_ PerlIO *f)
1925 return PerlIOValid(f) ? PerlIO_fileno(PerlIONext(f)) : -1;
1929 PerlIO_modestr(PerlIO * f, char *buf)
1932 if (PerlIOValid(f)) {
1933 IV flags = PerlIOBase(f)->flags;
1934 if (flags & PERLIO_F_APPEND) {
1936 if (flags & PERLIO_F_CANREAD) {
1940 else if (flags & PERLIO_F_CANREAD) {
1942 if (flags & PERLIO_F_CANWRITE)
1945 else if (flags & PERLIO_F_CANWRITE) {
1947 if (flags & PERLIO_F_CANREAD) {
1951 #ifdef PERLIO_USING_CRLF
1952 if (!(flags & PERLIO_F_CRLF))
1962 PerlIOBase_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1964 PerlIOl *l = PerlIOBase(f);
1966 const char *omode = mode;
1969 l->flags &= ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE |
1970 PERLIO_F_TRUNCATE | PERLIO_F_APPEND);
1971 if (tab->Set_ptrcnt != NULL)
1972 l->flags |= PERLIO_F_FASTGETS;
1974 if (*mode == IoTYPE_NUMERIC || *mode == IoTYPE_IMPLICIT)
1978 l->flags |= PERLIO_F_CANREAD;
1981 l->flags |= PERLIO_F_APPEND | PERLIO_F_CANWRITE;
1984 l->flags |= PERLIO_F_TRUNCATE | PERLIO_F_CANWRITE;
1987 SETERRNO(EINVAL, LIB_INVARG);
1993 l->flags |= PERLIO_F_CANREAD | PERLIO_F_CANWRITE;
1996 l->flags &= ~PERLIO_F_CRLF;
1999 l->flags |= PERLIO_F_CRLF;
2002 SETERRNO(EINVAL, LIB_INVARG);
2009 l->flags |= l->next->flags &
2010 (PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_TRUNCATE |
2015 PerlIO_debug("PerlIOBase_pushed f=%p %s %s fl=%08" UVxf " (%s)\n",
2016 f, PerlIOBase(f)->tab->name, (omode) ? omode : "(Null)",
2017 l->flags, PerlIO_modestr(f, temp));
2023 PerlIOBase_popped(pTHX_ PerlIO *f)
2029 PerlIOBase_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
2032 * Save the position as current head considers it
2034 Off_t old = PerlIO_tell(f);
2036 PerlIO_push(aTHX_ f, &PerlIO_pending, "r", Nullsv);
2037 PerlIOSelf(f, PerlIOBuf)->posn = old;
2038 done = PerlIOBuf_unread(aTHX_ f, vbuf, count);
2043 PerlIOBase_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
2045 STDCHAR *buf = (STDCHAR *) vbuf;
2047 if (!(PerlIOBase(f)->flags & PERLIO_F_CANREAD)) {
2048 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2049 SETERRNO(EBADF, SS_IVCHAN);
2053 SSize_t avail = PerlIO_get_cnt(f);
2056 take = ((SSize_t)count < avail) ? count : avail;
2058 STDCHAR *ptr = PerlIO_get_ptr(f);
2059 Copy(ptr, buf, take, STDCHAR);
2060 PerlIO_set_ptrcnt(f, ptr + take, (avail -= take));
2064 if (count > 0 && avail <= 0) {
2065 if (PerlIO_fill(f) != 0)
2069 return (buf - (STDCHAR *) vbuf);
2075 PerlIOBase_noop_ok(pTHX_ PerlIO *f)
2081 PerlIOBase_noop_fail(pTHX_ PerlIO *f)
2087 PerlIOBase_close(pTHX_ PerlIO *f)
2090 if (PerlIOValid(f)) {
2091 PerlIO *n = PerlIONext(f);
2092 code = PerlIO_flush(f);
2093 PerlIOBase(f)->flags &=
2094 ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_OPEN);
2095 while (PerlIOValid(n)) {
2096 PerlIO_funcs *tab = PerlIOBase(n)->tab;
2097 if (tab && tab->Close) {
2098 if ((*tab->Close)(aTHX_ n) != 0)
2103 PerlIOBase(n)->flags &=
2104 ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_OPEN);
2110 SETERRNO(EBADF, SS_IVCHAN);
2116 PerlIOBase_eof(pTHX_ PerlIO *f)
2118 if (PerlIOValid(f)) {
2119 return (PerlIOBase(f)->flags & PERLIO_F_EOF) != 0;
2125 PerlIOBase_error(pTHX_ PerlIO *f)
2127 if (PerlIOValid(f)) {
2128 return (PerlIOBase(f)->flags & PERLIO_F_ERROR) != 0;
2134 PerlIOBase_clearerr(pTHX_ PerlIO *f)
2136 if (PerlIOValid(f)) {
2137 PerlIO *n = PerlIONext(f);
2138 PerlIOBase(f)->flags &= ~(PERLIO_F_ERROR | PERLIO_F_EOF);
2145 PerlIOBase_setlinebuf(pTHX_ PerlIO *f)
2147 if (PerlIOValid(f)) {
2148 PerlIOBase(f)->flags |= PERLIO_F_LINEBUF;
2153 PerlIO_sv_dup(pTHX_ SV *arg, CLONE_PARAMS *param)
2159 return sv_dup(arg, param);
2162 return newSVsv(arg);
2165 return newSVsv(arg);
2170 PerlIOBase_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2172 PerlIO *nexto = PerlIONext(o);
2173 if (PerlIOValid(nexto)) {
2174 PerlIO_funcs *tab = PerlIOBase(nexto)->tab;
2175 if (tab && tab->Dup)
2176 f = (*tab->Dup)(aTHX_ f, nexto, param, flags);
2178 f = PerlIOBase_dup(aTHX_ f, nexto, param, flags);
2181 PerlIO_funcs *self = PerlIOBase(o)->tab;
2184 PerlIO_debug("PerlIOBase_dup %s f=%p o=%p param=%p\n",
2185 self->name, (void*)f, (void*)o, (void*)param);
2187 arg = (*self->Getarg)(aTHX_ o, param, flags);
2191 f = PerlIO_push(aTHX_ f, self, PerlIO_modestr(o,buf), arg);
2199 #define PERLIO_MAX_REFCOUNTABLE_FD 2048
2201 perl_mutex PerlIO_mutex;
2203 int PerlIO_fd_refcnt[PERLIO_MAX_REFCOUNTABLE_FD];
2208 /* Place holder for stdstreams call ??? */
2210 MUTEX_INIT(&PerlIO_mutex);
2215 PerlIOUnix_refcnt_inc(int fd)
2217 if (fd >= 0 && fd < PERLIO_MAX_REFCOUNTABLE_FD) {
2219 MUTEX_LOCK(&PerlIO_mutex);
2221 PerlIO_fd_refcnt[fd]++;
2222 PerlIO_debug("fd %d refcnt=%d\n",fd,PerlIO_fd_refcnt[fd]);
2224 MUTEX_UNLOCK(&PerlIO_mutex);
2230 PerlIOUnix_refcnt_dec(int fd)
2233 if (fd >= 0 && fd < PERLIO_MAX_REFCOUNTABLE_FD) {
2235 MUTEX_LOCK(&PerlIO_mutex);
2237 cnt = --PerlIO_fd_refcnt[fd];
2238 PerlIO_debug("fd %d refcnt=%d\n",fd,cnt);
2240 MUTEX_UNLOCK(&PerlIO_mutex);
2247 PerlIO_cleanup(pTHX)
2251 PerlIO_debug("Cleanup layers for %p\n",aTHX);
2253 PerlIO_debug("Cleanup layers\n");
2255 /* Raise STDIN..STDERR refcount so we don't close them */
2256 for (i=0; i < 3; i++)
2257 PerlIOUnix_refcnt_inc(i);
2258 PerlIO_cleantable(aTHX_ &PL_perlio);
2259 /* Restore STDIN..STDERR refcount */
2260 for (i=0; i < 3; i++)
2261 PerlIOUnix_refcnt_dec(i);
2263 if (PL_known_layers) {
2264 PerlIO_list_free(aTHX_ PL_known_layers);
2265 PL_known_layers = NULL;
2267 if(PL_def_layerlist) {
2268 PerlIO_list_free(aTHX_ PL_def_layerlist);
2269 PL_def_layerlist = NULL;
2275 /*--------------------------------------------------------------------------------------*/
2277 * Bottom-most level for UNIX-like case
2281 struct _PerlIO base; /* The generic part */
2282 int fd; /* UNIX like file descriptor */
2283 int oflags; /* open/fcntl flags */
2287 PerlIOUnix_oflags(const char *mode)
2290 if (*mode == IoTYPE_IMPLICIT || *mode == IoTYPE_NUMERIC)
2295 if (*++mode == '+') {
2302 oflags = O_CREAT | O_TRUNC;
2303 if (*++mode == '+') {
2312 oflags = O_CREAT | O_APPEND;
2313 if (*++mode == '+') {
2326 else if (*mode == 't') {
2328 oflags &= ~O_BINARY;
2332 * Always open in binary mode
2335 if (*mode || oflags == -1) {
2336 SETERRNO(EINVAL, LIB_INVARG);
2343 PerlIOUnix_fileno(pTHX_ PerlIO *f)
2345 return PerlIOSelf(f, PerlIOUnix)->fd;
2349 PerlIOUnix_setfd(pTHX_ PerlIO *f, int fd, int imode)
2351 PerlIOUnix *s = PerlIOSelf(f, PerlIOUnix);
2354 if (PerlLIO_fstat(fd, &st) == 0) {
2355 if (!S_ISREG(st.st_mode)) {
2356 PerlIO_debug("%d is not regular file\n",fd);
2357 PerlIOBase(f)->flags |= PERLIO_F_NOTREG;
2360 PerlIO_debug("%d _is_ a regular file\n",fd);
2366 PerlIOUnix_refcnt_inc(fd);
2370 PerlIOUnix_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2372 IV code = PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
2373 if (*PerlIONext(f)) {
2374 /* We never call down so do any pending stuff now */
2375 PerlIO_flush(PerlIONext(f));
2377 * XXX could (or should) we retrieve the oflags from the open file
2378 * handle rather than believing the "mode" we are passed in? XXX
2379 * Should the value on NULL mode be 0 or -1?
2381 PerlIOUnix_setfd(aTHX_ f, PerlIO_fileno(PerlIONext(f)),
2382 mode ? PerlIOUnix_oflags(mode) : -1);
2384 PerlIOBase(f)->flags |= PERLIO_F_OPEN;
2390 PerlIOUnix_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
2392 int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2394 if (PerlIOBase(f)->flags & PERLIO_F_NOTREG) {
2396 SETERRNO(ESPIPE, LIB_INVARG);
2398 SETERRNO(EINVAL, LIB_INVARG);
2402 new = PerlLIO_lseek(fd, offset, whence);
2403 if (new == (Off_t) - 1)
2407 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
2412 PerlIOUnix_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
2413 IV n, const char *mode, int fd, int imode,
2414 int perm, PerlIO *f, int narg, SV **args)
2416 if (PerlIOValid(f)) {
2417 if (PerlIOBase(f)->flags & PERLIO_F_OPEN)
2418 (*PerlIOBase(f)->tab->Close)(aTHX_ f);
2421 char *path = SvPV_nolen(*args);
2422 if (*mode == IoTYPE_NUMERIC)
2425 imode = PerlIOUnix_oflags(mode);
2429 fd = PerlLIO_open3(path, imode, perm);
2433 if (*mode == IoTYPE_IMPLICIT)
2436 f = PerlIO_allocate(aTHX);
2438 if (!PerlIOValid(f)) {
2439 if (!(f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg))) {
2443 PerlIOUnix_setfd(aTHX_ f, fd, imode);
2444 PerlIOBase(f)->flags |= PERLIO_F_OPEN;
2445 if (*mode == IoTYPE_APPEND)
2446 PerlIOUnix_seek(aTHX_ f, 0, SEEK_END);
2452 * FIXME: pop layers ???
2460 PerlIOUnix_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2462 PerlIOUnix *os = PerlIOSelf(o, PerlIOUnix);
2464 if (flags & PERLIO_DUP_FD) {
2465 fd = PerlLIO_dup(fd);
2467 if (fd >= 0 && fd < PERLIO_MAX_REFCOUNTABLE_FD) {
2468 f = PerlIOBase_dup(aTHX_ f, o, param, flags);
2470 /* If all went well overwrite fd in dup'ed lay with the dup()'ed fd */
2471 PerlIOUnix_setfd(aTHX_ f, fd, os->oflags);
2480 PerlIOUnix_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
2482 int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2483 if (!(PerlIOBase(f)->flags & PERLIO_F_CANREAD) ||
2484 PerlIOBase(f)->flags & (PERLIO_F_EOF|PERLIO_F_ERROR)) {
2488 SSize_t len = PerlLIO_read(fd, vbuf, count);
2489 if (len >= 0 || errno != EINTR) {
2491 if (errno != EAGAIN) {
2492 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2495 else if (len == 0 && count != 0) {
2496 PerlIOBase(f)->flags |= PERLIO_F_EOF;
2506 PerlIOUnix_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
2508 int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2510 SSize_t len = PerlLIO_write(fd, vbuf, count);
2511 if (len >= 0 || errno != EINTR) {
2513 if (errno != EAGAIN) {
2514 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2524 PerlIOUnix_tell(pTHX_ PerlIO *f)
2526 return PerlLIO_lseek(PerlIOSelf(f, PerlIOUnix)->fd, 0, SEEK_CUR);
2531 PerlIOUnix_close(pTHX_ PerlIO *f)
2533 int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2535 if (PerlIOBase(f)->flags & PERLIO_F_OPEN) {
2536 if (PerlIOUnix_refcnt_dec(fd) > 0) {
2537 PerlIOBase(f)->flags &= ~PERLIO_F_OPEN;
2542 SETERRNO(EBADF,SS_IVCHAN);
2545 while (PerlLIO_close(fd) != 0) {
2546 if (errno != EINTR) {
2553 PerlIOBase(f)->flags &= ~PERLIO_F_OPEN;
2558 PerlIO_funcs PerlIO_unix = {
2559 sizeof(PerlIO_funcs),
2566 PerlIOBase_binmode, /* binmode */
2576 PerlIOBase_noop_ok, /* flush */
2577 PerlIOBase_noop_fail, /* fill */
2580 PerlIOBase_clearerr,
2581 PerlIOBase_setlinebuf,
2582 NULL, /* get_base */
2583 NULL, /* get_bufsiz */
2586 NULL, /* set_ptrcnt */
2589 /*--------------------------------------------------------------------------------------*/
2594 #if defined(VMS) && !defined(STDIO_BUFFER_WRITABLE)
2595 /* perl5.8 - This ensures the last minute VMS ungetc fix is not
2596 broken by the last second glibc 2.3 fix
2598 #define STDIO_BUFFER_WRITABLE
2603 struct _PerlIO base;
2604 FILE *stdio; /* The stream */
2608 PerlIOStdio_fileno(pTHX_ PerlIO *f)
2611 if (PerlIOValid(f) && (s = PerlIOSelf(f, PerlIOStdio)->stdio)) {
2612 return PerlSIO_fileno(s);
2619 PerlIOStdio_mode(const char *mode, char *tmode)
2627 #if defined(PERLIO_USING_CRLF) || defined(__CYGWIN__)
2635 PerlIOStdio_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2638 if (PerlIOValid(f) && PerlIOValid(n = PerlIONext(f))) {
2639 PerlIO_funcs *toptab = PerlIOBase(n)->tab;
2640 if (toptab == tab) {
2641 /* Top is already stdio - pop self (duplicate) and use original */
2642 PerlIO_pop(aTHX_ f);
2645 int fd = PerlIO_fileno(n);
2648 if (fd >= 0 && (stdio = PerlSIO_fdopen(fd,
2649 mode = PerlIOStdio_mode(mode, tmode)))) {
2650 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2651 /* We never call down so do any pending stuff now */
2652 PerlIO_flush(PerlIONext(f));
2659 return PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
2664 PerlIO_importFILE(FILE *stdio, const char *mode)
2670 if (!mode || !*mode) {
2671 /* We need to probe to see how we can open the stream
2672 so start with read/write and then try write and read
2673 we dup() so that we can fclose without loosing the fd.
2675 Note that the errno value set by a failing fdopen
2676 varies between stdio implementations.
2678 int fd = PerlLIO_dup(fileno(stdio));
2679 FILE *f2 = PerlSIO_fdopen(fd, (mode = "r+"));
2681 f2 = PerlSIO_fdopen(fd, (mode = "w"));
2684 f2 = PerlSIO_fdopen(fd, (mode = "r"));
2687 /* Don't seem to be able to open */
2693 if ((f = PerlIO_push(aTHX_(f = PerlIO_allocate(aTHX)), &PerlIO_stdio, mode, Nullsv))) {
2694 s = PerlIOSelf(f, PerlIOStdio);
2702 PerlIOStdio_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
2703 IV n, const char *mode, int fd, int imode,
2704 int perm, PerlIO *f, int narg, SV **args)
2707 if (PerlIOValid(f)) {
2708 char *path = SvPV_nolen(*args);
2709 PerlIOStdio *s = PerlIOSelf(f, PerlIOStdio);
2711 PerlIOUnix_refcnt_dec(fileno(s->stdio));
2712 stdio = PerlSIO_freopen(path, (mode = PerlIOStdio_mode(mode, tmode)),
2717 PerlIOUnix_refcnt_inc(fileno(s->stdio));
2722 char *path = SvPV_nolen(*args);
2723 if (*mode == IoTYPE_NUMERIC) {
2725 fd = PerlLIO_open3(path, imode, perm);
2729 bool appended = FALSE;
2731 /* Cygwin wants its 'b' early. */
2733 mode = PerlIOStdio_mode(mode, tmode);
2735 stdio = PerlSIO_fopen(path, mode);
2739 f = PerlIO_allocate(aTHX);
2742 mode = PerlIOStdio_mode(mode, tmode);
2743 f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg);
2745 s = PerlIOSelf(f, PerlIOStdio);
2747 PerlIOUnix_refcnt_inc(fileno(s->stdio));
2759 if (*mode == IoTYPE_IMPLICIT) {
2766 stdio = PerlSIO_stdin;
2769 stdio = PerlSIO_stdout;
2772 stdio = PerlSIO_stderr;
2777 stdio = PerlSIO_fdopen(fd, mode =
2778 PerlIOStdio_mode(mode, tmode));
2783 f = PerlIO_allocate(aTHX);
2785 if ((f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg))) {
2786 s = PerlIOSelf(f, PerlIOStdio);
2788 PerlIOUnix_refcnt_inc(fileno(s->stdio));
2798 PerlIOStdio_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2800 /* This assumes no layers underneath - which is what
2801 happens, but is not how I remember it. NI-S 2001/10/16
2803 if ((f = PerlIOBase_dup(aTHX_ f, o, param, flags))) {
2804 FILE *stdio = PerlIOSelf(o, PerlIOStdio)->stdio;
2805 int fd = fileno(stdio);
2807 if (flags & PERLIO_DUP_FD) {
2808 int dfd = PerlLIO_dup(fileno(stdio));
2810 stdio = PerlSIO_fdopen(dfd, PerlIO_modestr(o,mode));
2814 /* FIXME: To avoid messy error recovery if dup fails
2815 re-use the existing stdio as though flag was not set
2819 stdio = PerlSIO_fdopen(fd, PerlIO_modestr(o,mode));
2821 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2822 PerlIOUnix_refcnt_inc(fileno(stdio));
2828 PerlIOStdio_invalidate_fileno(pTHX_ FILE *f)
2830 /* XXX this could use PerlIO_canset_fileno() and
2831 * PerlIO_set_fileno() support from Configure
2833 # if defined(__GLIBC__)
2834 /* There may be a better way for GLIBC:
2835 - libio.h defines a flag to not close() on cleanup
2839 # elif defined(__sun__)
2841 /* On solaris, if _LP64 is defined, the FILE structure is this:
2847 * It turns out that the fd is stored in the top 32 bits of
2848 * file->__pad[4]. The lower 32 bits contain flags. file->pad[5] appears
2849 * to contain a pointer or offset into another structure. All the
2850 * remaining fields are zero.
2852 * We set the top bits to -1 (0xFFFFFFFF).
2854 f->__pad[4] |= 0xffffffff00000000L;
2855 assert(fileno(f) == 0xffffffff);
2856 # else /* !defined(_LP64) */
2857 /* _file is just a unsigned char :-(
2858 Not clear why we dup() rather than using -1
2859 even if that would be treated as 0xFF - so will
2862 f->_file = PerlLIO_dup(fileno(f));
2863 # endif /* defined(_LP64) */
2865 # elif defined(__hpux)
2869 /* Next one ->_file seems to be a reasonable fallback, i.e. if
2870 your platform does not have special entry try this one.
2871 [For OSF only have confirmation for Tru64 (alpha)
2872 but assume other OSFs will be similar.]
2874 # elif defined(_AIX) || defined(__osf__) || defined(__irix__)
2877 # elif defined(__FreeBSD__)
2878 /* There may be a better way on FreeBSD:
2879 - we could insert a dummy func in the _close function entry
2880 f->_close = (int (*)(void *)) dummy_close;
2884 # elif defined(__EMX__)
2885 /* f->_flags &= ~_IOOPEN; */ /* Will leak stream->_buffer */
2888 # elif defined(__CYGWIN__)
2889 /* There may be a better way on CYGWIN:
2890 - we could insert a dummy func in the _close function entry
2891 f->_close = (int (*)(void *)) dummy_close;
2895 # elif defined(WIN32)
2896 # if defined(__BORLANDC__)
2897 f->fd = PerlLIO_dup(fileno(f));
2898 # elif defined(UNDER_CE)
2899 /* WIN_CE does not have access to FILE internals, it hardly has FILE
2908 /* Sarathy's code did this - we fall back to a dup/dup2 hack
2909 (which isn't thread safe) instead
2911 # error "Don't know how to set FILE.fileno on your platform"
2918 PerlIOStdio_close(pTHX_ PerlIO *f)
2920 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
2926 int fd = fileno(stdio);
2932 #ifdef SOCKS5_VERSION_NAME
2933 /* Socks lib overrides close() but stdio isn't linked to
2934 that library (though we are) - so we must call close()
2935 on sockets on stdio's behalf.
2938 Sock_size_t optlen = sizeof(int);
2939 if (getsockopt(fd, SOL_SOCKET, SO_TYPE, (void *) &optval, &optlen) == 0) {
2944 if (PerlIOUnix_refcnt_dec(fd) > 0) {
2945 /* File descriptor still in use */
2950 /* For STD* handles don't close the stdio at all
2951 this is because we have shared the FILE * too
2953 if (stdio == stdin) {
2954 /* Some stdios are buggy fflush-ing inputs */
2957 else if (stdio == stdout || stdio == stderr) {
2958 return PerlIO_flush(f);
2960 /* Tricky - must fclose(stdio) to free memory but not close(fd)
2961 Use Sarathy's trick from maint-5.6 to invalidate the
2962 fileno slot of the FILE *
2964 result = PerlIO_flush(f);
2966 if (!(invalidate = PerlIOStdio_invalidate_fileno(aTHX_ stdio))) {
2967 dupfd = PerlLIO_dup(fd);
2970 result = PerlSIO_fclose(stdio);
2971 /* We treat error from stdio as success if we invalidated
2972 errno may NOT be expected EBADF
2974 if (invalidate && result != 0) {
2979 /* in SOCKS case let close() determine return value */
2983 PerlLIO_dup2(dupfd,fd);
2984 PerlLIO_close(dupfd);
2991 PerlIOStdio_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
2993 FILE *s = PerlIOSelf(f, PerlIOStdio)->stdio;
2997 STDCHAR *buf = (STDCHAR *) vbuf;
2999 * Perl is expecting PerlIO_getc() to fill the buffer Linux's
3000 * stdio does not do that for fread()
3002 int ch = PerlSIO_fgetc(s);
3009 got = PerlSIO_fread(vbuf, 1, count, s);
3010 if (got == 0 && PerlSIO_ferror(s))
3012 if (got >= 0 || errno != EINTR)
3015 SETERRNO(0,0); /* just in case */
3021 PerlIOStdio_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3024 FILE *s = PerlIOSelf(f, PerlIOStdio)->stdio;
3026 #ifdef STDIO_BUFFER_WRITABLE
3027 if (PerlIO_fast_gets(f) && PerlIO_has_base(f)) {
3028 STDCHAR *buf = ((STDCHAR *) vbuf) + count;
3029 STDCHAR *base = PerlIO_get_base(f);
3030 SSize_t cnt = PerlIO_get_cnt(f);
3031 STDCHAR *ptr = PerlIO_get_ptr(f);
3032 SSize_t avail = ptr - base;
3034 if (avail > count) {
3038 Move(buf-avail,ptr,avail,STDCHAR);
3041 PerlIO_set_ptrcnt(f,ptr,cnt+avail);
3042 if (PerlSIO_feof(s) && unread >= 0)
3043 PerlSIO_clearerr(s);
3048 if (PerlIO_has_cntptr(f)) {
3049 /* We can get pointer to buffer but not its base
3050 Do ungetc() but check chars are ending up in the
3053 STDCHAR *eptr = (STDCHAR*)PerlSIO_get_ptr(s);
3054 STDCHAR *buf = ((STDCHAR *) vbuf) + count;
3056 int ch = *--buf & 0xFF;
3057 if (ungetc(ch,s) != ch) {
3058 /* ungetc did not work */
3061 if ((STDCHAR*)PerlSIO_get_ptr(s) != --eptr || ((*eptr & 0xFF) != ch)) {
3062 /* Did not change pointer as expected */
3063 fgetc(s); /* get char back again */
3073 unread += PerlIOBase_unread(aTHX_ f, vbuf, count);
3079 PerlIOStdio_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3083 got = PerlSIO_fwrite(vbuf, 1, count,
3084 PerlIOSelf(f, PerlIOStdio)->stdio);
3085 if (got >= 0 || errno != EINTR)
3088 SETERRNO(0,0); /* just in case */
3094 PerlIOStdio_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3096 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3097 return PerlSIO_fseek(stdio, offset, whence);
3101 PerlIOStdio_tell(pTHX_ PerlIO *f)
3103 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3104 return PerlSIO_ftell(stdio);
3108 PerlIOStdio_flush(pTHX_ PerlIO *f)
3110 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3111 if (PerlIOBase(f)->flags & PERLIO_F_CANWRITE) {
3112 return PerlSIO_fflush(stdio);
3117 * FIXME: This discards ungetc() and pre-read stuff which is not
3118 * right if this is just a "sync" from a layer above Suspect right
3119 * design is to do _this_ but not have layer above flush this
3120 * layer read-to-read
3123 * Not writeable - sync by attempting a seek
3126 if (PerlSIO_fseek(stdio, (Off_t) 0, SEEK_CUR) != 0)
3134 PerlIOStdio_eof(pTHX_ PerlIO *f)
3136 return PerlSIO_feof(PerlIOSelf(f, PerlIOStdio)->stdio);
3140 PerlIOStdio_error(pTHX_ PerlIO *f)
3142 return PerlSIO_ferror(PerlIOSelf(f, PerlIOStdio)->stdio);
3146 PerlIOStdio_clearerr(pTHX_ PerlIO *f)
3148 PerlSIO_clearerr(PerlIOSelf(f, PerlIOStdio)->stdio);
3152 PerlIOStdio_setlinebuf(pTHX_ PerlIO *f)
3154 #ifdef HAS_SETLINEBUF
3155 PerlSIO_setlinebuf(PerlIOSelf(f, PerlIOStdio)->stdio);
3157 PerlSIO_setvbuf(PerlIOSelf(f, PerlIOStdio)->stdio, Nullch, _IOLBF, 0);
3163 PerlIOStdio_get_base(pTHX_ PerlIO *f)
3165 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3166 return (STDCHAR*)PerlSIO_get_base(stdio);
3170 PerlIOStdio_get_bufsiz(pTHX_ PerlIO *f)
3172 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3173 return PerlSIO_get_bufsiz(stdio);
3177 #ifdef USE_STDIO_PTR
3179 PerlIOStdio_get_ptr(pTHX_ PerlIO *f)
3181 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3182 return (STDCHAR*)PerlSIO_get_ptr(stdio);
3186 PerlIOStdio_get_cnt(pTHX_ PerlIO *f)
3188 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3189 return PerlSIO_get_cnt(stdio);
3193 PerlIOStdio_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
3195 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3197 #ifdef STDIO_PTR_LVALUE
3198 PerlSIO_set_ptr(stdio, (void*)ptr); /* LHS STDCHAR* cast non-portable */
3199 #ifdef STDIO_PTR_LVAL_SETS_CNT
3200 if (PerlSIO_get_cnt(stdio) != (cnt)) {
3201 assert(PerlSIO_get_cnt(stdio) == (cnt));
3204 #if (!defined(STDIO_PTR_LVAL_NOCHANGE_CNT))
3206 * Setting ptr _does_ change cnt - we are done
3210 #else /* STDIO_PTR_LVALUE */
3212 #endif /* STDIO_PTR_LVALUE */
3215 * Now (or only) set cnt
3217 #ifdef STDIO_CNT_LVALUE
3218 PerlSIO_set_cnt(stdio, cnt);
3219 #else /* STDIO_CNT_LVALUE */
3220 #if (defined(STDIO_PTR_LVALUE) && defined(STDIO_PTR_LVAL_SETS_CNT))
3221 PerlSIO_set_ptr(stdio,
3222 PerlSIO_get_ptr(stdio) + (PerlSIO_get_cnt(stdio) -
3224 #else /* STDIO_PTR_LVAL_SETS_CNT */
3226 #endif /* STDIO_PTR_LVAL_SETS_CNT */
3227 #endif /* STDIO_CNT_LVALUE */
3234 PerlIOStdio_fill(pTHX_ PerlIO *f)
3236 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3239 * fflush()ing read-only streams can cause trouble on some stdio-s
3241 if ((PerlIOBase(f)->flags & PERLIO_F_CANWRITE)) {
3242 if (PerlSIO_fflush(stdio) != 0)
3245 c = PerlSIO_fgetc(stdio);
3249 #if (defined(STDIO_PTR_LVALUE) && (defined(STDIO_CNT_LVALUE) || defined(STDIO_PTR_LVAL_SETS_CNT)))
3251 #ifdef STDIO_BUFFER_WRITABLE
3252 if (PerlIO_fast_gets(f) && PerlIO_has_base(f)) {
3253 /* Fake ungetc() to the real buffer in case system's ungetc
3256 STDCHAR *base = (STDCHAR*)PerlSIO_get_base(stdio);
3257 SSize_t cnt = PerlSIO_get_cnt(stdio);
3258 STDCHAR *ptr = (STDCHAR*)PerlSIO_get_ptr(stdio);
3259 if (ptr == base+1) {
3260 *--ptr = (STDCHAR) c;
3261 PerlIOStdio_set_ptrcnt(aTHX_ f,ptr,cnt+1);
3262 if (PerlSIO_feof(stdio))
3263 PerlSIO_clearerr(stdio);
3269 if (PerlIO_has_cntptr(f)) {
3271 if (PerlIOStdio_unread(aTHX_ f,&ch,1) == 1) {
3278 /* An ungetc()d char is handled separately from the regular
3279 * buffer, so we stuff it in the buffer ourselves.
3280 * Should never get called as should hit code above
3282 *(--((*stdio)->_ptr)) = (unsigned char) c;
3285 /* If buffer snoop scheme above fails fall back to
3288 if (PerlSIO_ungetc(c, stdio) != c)
3296 PerlIO_funcs PerlIO_stdio = {
3297 sizeof(PerlIO_funcs),
3299 sizeof(PerlIOStdio),
3300 PERLIO_K_BUFFERED|PERLIO_K_RAW,
3304 PerlIOBase_binmode, /* binmode */
3318 PerlIOStdio_clearerr,
3319 PerlIOStdio_setlinebuf,
3321 PerlIOStdio_get_base,
3322 PerlIOStdio_get_bufsiz,
3327 #ifdef USE_STDIO_PTR
3328 PerlIOStdio_get_ptr,
3329 PerlIOStdio_get_cnt,
3330 # if defined(HAS_FAST_STDIO) && defined(USE_FAST_STDIO)
3331 PerlIOStdio_set_ptrcnt,
3334 # endif /* HAS_FAST_STDIO && USE_FAST_STDIO */
3339 #endif /* USE_STDIO_PTR */
3342 /* Note that calls to PerlIO_exportFILE() are reversed using
3343 * PerlIO_releaseFILE(), not importFILE. */
3345 PerlIO_exportFILE(PerlIO * f, const char *mode)
3349 if (PerlIOValid(f)) {
3352 if (!mode || !*mode) {
3353 mode = PerlIO_modestr(f, buf);
3355 stdio = PerlSIO_fdopen(PerlIO_fileno(f), mode);
3359 /* De-link any lower layers so new :stdio sticks */
3361 if ((f2 = PerlIO_push(aTHX_ f, &PerlIO_stdio, buf, Nullsv))) {
3362 PerlIOStdio *s = PerlIOSelf((f = f2), PerlIOStdio);
3364 /* Link previous lower layers under new one */
3368 /* restore layers list */
3378 PerlIO_findFILE(PerlIO *f)
3382 if (l->tab == &PerlIO_stdio) {
3383 PerlIOStdio *s = PerlIOSelf(&l, PerlIOStdio);
3386 l = *PerlIONext(&l);
3388 /* Uses fallback "mode" via PerlIO_modestr() in PerlIO_exportFILE */
3389 return PerlIO_exportFILE(f, Nullch);
3392 /* Use this to reverse PerlIO_exportFILE calls. */
3394 PerlIO_releaseFILE(PerlIO *p, FILE *f)
3398 if (l->tab == &PerlIO_stdio) {
3399 PerlIOStdio *s = PerlIOSelf(&l, PerlIOStdio);
3400 if (s->stdio == f) {
3402 PerlIO_pop(aTHX_ p);
3411 /*--------------------------------------------------------------------------------------*/
3413 * perlio buffer layer
3417 PerlIOBuf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
3419 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3420 int fd = PerlIO_fileno(f);
3421 if (fd >= 0 && PerlLIO_isatty(fd)) {
3422 PerlIOBase(f)->flags |= PERLIO_F_LINEBUF | PERLIO_F_TTY;
3424 if (*PerlIONext(f)) {
3425 Off_t posn = PerlIO_tell(PerlIONext(f));
3426 if (posn != (Off_t) - 1) {
3430 return PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
3434 PerlIOBuf_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
3435 IV n, const char *mode, int fd, int imode, int perm,
3436 PerlIO *f, int narg, SV **args)
3438 if (PerlIOValid(f)) {
3439 PerlIO *next = PerlIONext(f);
3441 PerlIO_layer_fetch(aTHX_ layers, n - 1, PerlIOBase(next)->tab);
3442 if (tab && tab->Open)
3444 (*tab->Open)(aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
3446 if (!next || (*PerlIOBase(f)->tab->Pushed) (aTHX_ f, mode, PerlIOArg, self) != 0) {
3451 PerlIO_funcs *tab = PerlIO_layer_fetch(aTHX_ layers, n - 1, PerlIO_default_btm());
3453 if (*mode == IoTYPE_IMPLICIT) {
3459 if (tab && tab->Open)
3460 f = (*tab->Open)(aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
3463 SETERRNO(EINVAL, LIB_INVARG);
3465 if (PerlIO_push(aTHX_ f, self, mode, PerlIOArg) == 0) {
3467 * if push fails during open, open fails. close will pop us.
3472 fd = PerlIO_fileno(f);
3473 if (init && fd == 2) {
3475 * Initial stderr is unbuffered
3477 PerlIOBase(f)->flags |= PERLIO_F_UNBUF;
3479 #ifdef PERLIO_USING_CRLF
3480 # ifdef PERLIO_IS_BINMODE_FD
3481 if (PERLIO_IS_BINMODE_FD(fd))
3482 PerlIO_binmode(aTHX_ f, '<'/*not used*/, O_BINARY, Nullch);
3486 * do something about failing setmode()? --jhi
3488 PerlLIO_setmode(fd, O_BINARY);
3497 * This "flush" is akin to sfio's sync in that it handles files in either
3498 * read or write state
3501 PerlIOBuf_flush(pTHX_ PerlIO *f)
3503 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3505 PerlIO *n = PerlIONext(f);
3506 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF) {
3508 * write() the buffer
3510 STDCHAR *buf = b->buf;
3512 while (p < b->ptr) {
3513 SSize_t count = PerlIO_write(n, p, b->ptr - p);
3517 else if (count < 0 || PerlIO_error(n)) {
3518 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
3523 b->posn += (p - buf);
3525 else if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3526 STDCHAR *buf = PerlIO_get_base(f);
3528 * Note position change
3530 b->posn += (b->ptr - buf);
3531 if (b->ptr < b->end) {
3532 /* We did not consume all of it - try and seek downstream to
3533 our logical position
3535 if (PerlIOValid(n) && PerlIO_seek(n, b->posn, SEEK_SET) == 0) {
3536 /* Reload n as some layers may pop themselves on seek */
3537 b->posn = PerlIO_tell(n = PerlIONext(f));
3540 /* Seek failed (e.g. pipe or tty). Do NOT clear buffer or pre-read
3541 data is lost for good - so return saying "ok" having undone
3544 b->posn -= (b->ptr - buf);
3549 b->ptr = b->end = b->buf;
3550 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3551 /* We check for Valid because of dubious decision to make PerlIO_flush(NULL) flush all */
3552 if (PerlIOValid(n) && PerlIO_flush(n) != 0)
3558 PerlIOBuf_fill(pTHX_ PerlIO *f)
3560 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3561 PerlIO *n = PerlIONext(f);
3564 * Down-stream flush is defined not to loose read data so is harmless.
3565 * we would not normally be fill'ing if there was data left in anycase.
3567 if (PerlIO_flush(f) != 0)
3569 if (PerlIOBase(f)->flags & PERLIO_F_TTY)
3570 PerlIOBase_flush_linebuf(aTHX);
3573 PerlIO_get_base(f); /* allocate via vtable */
3575 b->ptr = b->end = b->buf;
3577 if (!PerlIOValid(n)) {
3578 PerlIOBase(f)->flags |= PERLIO_F_EOF;
3582 if (PerlIO_fast_gets(n)) {
3584 * Layer below is also buffered. We do _NOT_ want to call its
3585 * ->Read() because that will loop till it gets what we asked for
3586 * which may hang on a pipe etc. Instead take anything it has to
3587 * hand, or ask it to fill _once_.
3589 avail = PerlIO_get_cnt(n);
3591 avail = PerlIO_fill(n);
3593 avail = PerlIO_get_cnt(n);
3595 if (!PerlIO_error(n) && PerlIO_eof(n))
3600 STDCHAR *ptr = PerlIO_get_ptr(n);
3601 SSize_t cnt = avail;
3602 if (avail > (SSize_t)b->bufsiz)
3604 Copy(ptr, b->buf, avail, STDCHAR);
3605 PerlIO_set_ptrcnt(n, ptr + avail, cnt - avail);
3609 avail = PerlIO_read(n, b->ptr, b->bufsiz);
3613 PerlIOBase(f)->flags |= PERLIO_F_EOF;
3615 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
3618 b->end = b->buf + avail;
3619 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3624 PerlIOBuf_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
3626 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3627 if (PerlIOValid(f)) {
3630 return PerlIOBase_read(aTHX_ f, vbuf, count);
3636 PerlIOBuf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3638 const STDCHAR *buf = (const STDCHAR *) vbuf + count;
3639 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3642 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
3647 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3649 * Buffer is already a read buffer, we can overwrite any chars
3650 * which have been read back to buffer start
3652 avail = (b->ptr - b->buf);
3656 * Buffer is idle, set it up so whole buffer is available for
3660 b->end = b->buf + avail;
3662 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3664 * Buffer extends _back_ from where we are now
3666 b->posn -= b->bufsiz;
3668 if (avail > (SSize_t) count) {
3670 * If we have space for more than count, just move count
3678 * In simple stdio-like ungetc() case chars will be already
3681 if (buf != b->ptr) {
3682 Copy(buf, b->ptr, avail, STDCHAR);
3686 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
3690 unread += PerlIOBase_unread(aTHX_ f, vbuf, count);
3696 PerlIOBuf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3698 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3699 const STDCHAR *buf = (const STDCHAR *) vbuf;
3700 const STDCHAR *flushptr = buf;
3704 if (!(PerlIOBase(f)->flags & PERLIO_F_CANWRITE))
3706 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3707 if (PerlIO_flush(f) != 0) {
3711 if (PerlIOBase(f)->flags & PERLIO_F_LINEBUF) {
3712 flushptr = buf + count;
3713 while (flushptr > buf && *(flushptr - 1) != '\n')
3717 SSize_t avail = b->bufsiz - (b->ptr - b->buf);
3718 if ((SSize_t) count < avail)
3720 if (flushptr > buf && flushptr <= buf + avail)
3721 avail = flushptr - buf;
3722 PerlIOBase(f)->flags |= PERLIO_F_WRBUF;
3724 Copy(buf, b->ptr, avail, STDCHAR);
3729 if (buf == flushptr)
3732 if (b->ptr >= (b->buf + b->bufsiz))
3735 if (PerlIOBase(f)->flags & PERLIO_F_UNBUF)
3741 PerlIOBuf_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3744 if ((code = PerlIO_flush(f)) == 0) {
3745 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3746 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
3747 code = PerlIO_seek(PerlIONext(f), offset, whence);
3749 b->posn = PerlIO_tell(PerlIONext(f));
3756 PerlIOBuf_tell(pTHX_ PerlIO *f)
3758 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3760 * b->posn is file position where b->buf was read, or will be written
3762 Off_t posn = b->posn;
3763 if ((PerlIOBase(f)->flags & PERLIO_F_APPEND) &&
3764 (PerlIOBase(f)->flags & PERLIO_F_WRBUF)) {
3766 /* As O_APPEND files are normally shared in some sense it is better
3771 /* when file is NOT shared then this is sufficient */
3772 PerlIO_seek(PerlIONext(f),0, SEEK_END);
3774 posn = b->posn = PerlIO_tell(PerlIONext(f));
3778 * If buffer is valid adjust position by amount in buffer
3780 posn += (b->ptr - b->buf);
3786 PerlIOBuf_popped(pTHX_ PerlIO *f)
3788 IV code = PerlIOBase_popped(aTHX_ f);
3789 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3790 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
3794 b->ptr = b->end = b->buf;
3795 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3800 PerlIOBuf_close(pTHX_ PerlIO *f)
3802 IV code = PerlIOBase_close(aTHX_ f);
3803 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3804 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
3808 b->ptr = b->end = b->buf;
3809 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3814 PerlIOBuf_get_ptr(pTHX_ PerlIO *f)
3816 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3823 PerlIOBuf_get_cnt(pTHX_ PerlIO *f)
3825 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3828 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF)
3829 return (b->end - b->ptr);
3834 PerlIOBuf_get_base(pTHX_ PerlIO *f)
3836 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3841 Newz('B',b->buf,b->bufsiz, STDCHAR);
3843 b->buf = (STDCHAR *) & b->oneword;
3844 b->bufsiz = sizeof(b->oneword);
3853 PerlIOBuf_bufsiz(pTHX_ PerlIO *f)
3855 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3858 return (b->end - b->buf);
3862 PerlIOBuf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
3864 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3868 if (PerlIO_get_cnt(f) != cnt || b->ptr < b->buf) {
3869 assert(PerlIO_get_cnt(f) == cnt);
3870 assert(b->ptr >= b->buf);
3872 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3876 PerlIOBuf_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
3878 return PerlIOBase_dup(aTHX_ f, o, param, flags);
3883 PerlIO_funcs PerlIO_perlio = {
3884 sizeof(PerlIO_funcs),
3887 PERLIO_K_BUFFERED|PERLIO_K_RAW,
3891 PerlIOBase_binmode, /* binmode */
3905 PerlIOBase_clearerr,
3906 PerlIOBase_setlinebuf,
3911 PerlIOBuf_set_ptrcnt,
3914 /*--------------------------------------------------------------------------------------*/
3916 * Temp layer to hold unread chars when cannot do it any other way
3920 PerlIOPending_fill(pTHX_ PerlIO *f)
3923 * Should never happen
3930 PerlIOPending_close(pTHX_ PerlIO *f)
3933 * A tad tricky - flush pops us, then we close new top
3936 return PerlIO_close(f);
3940 PerlIOPending_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3943 * A tad tricky - flush pops us, then we seek new top
3946 return PerlIO_seek(f, offset, whence);
3951 PerlIOPending_flush(pTHX_ PerlIO *f)
3953 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3954 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
3958 PerlIO_pop(aTHX_ f);
3963 PerlIOPending_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
3969 PerlIOBuf_set_ptrcnt(aTHX_ f, ptr, cnt);
3974 PerlIOPending_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
3976 IV code = PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
3977 PerlIOl *l = PerlIOBase(f);
3979 * Our PerlIO_fast_gets must match what we are pushed on, or sv_gets()
3980 * etc. get muddled when it changes mid-string when we auto-pop.
3982 l->flags = (l->flags & ~(PERLIO_F_FASTGETS | PERLIO_F_UTF8)) |
3983 (PerlIOBase(PerlIONext(f))->
3984 flags & (PERLIO_F_FASTGETS | PERLIO_F_UTF8));
3989 PerlIOPending_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
3991 SSize_t avail = PerlIO_get_cnt(f);
3993 if ((SSize_t)count < avail)
3996 got = PerlIOBuf_read(aTHX_ f, vbuf, avail);
3997 if (got >= 0 && got < (SSize_t)count) {
3999 PerlIO_read(f, ((STDCHAR *) vbuf) + got, count - got);
4000 if (more >= 0 || got == 0)
4006 PerlIO_funcs PerlIO_pending = {
4007 sizeof(PerlIO_funcs),
4010 PERLIO_K_BUFFERED|PERLIO_K_RAW, /* not sure about RAW here */
4011 PerlIOPending_pushed,
4014 PerlIOBase_binmode, /* binmode */
4023 PerlIOPending_close,
4024 PerlIOPending_flush,
4028 PerlIOBase_clearerr,
4029 PerlIOBase_setlinebuf,
4034 PerlIOPending_set_ptrcnt,
4039 /*--------------------------------------------------------------------------------------*/
4041 * crlf - translation On read translate CR,LF to "\n" we do this by
4042 * overriding ptr/cnt entries to hand back a line at a time and keeping a
4043 * record of which nl we "lied" about. On write translate "\n" to CR,LF
4047 PerlIOBuf base; /* PerlIOBuf stuff */
4048 STDCHAR *nl; /* Position of crlf we "lied" about in the
4053 PerlIOCrlf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
4056 PerlIOBase(f)->flags |= PERLIO_F_CRLF;
4057 code = PerlIOBuf_pushed(aTHX_ f, mode, arg, tab);
4059 PerlIO_debug("PerlIOCrlf_pushed f=%p %s %s fl=%08" UVxf "\n",
4060 f, PerlIOBase(f)->tab->name, (mode) ? mode : "(Null)",
4061 PerlIOBase(f)->flags);
4064 /* Enable the first CRLF capable layer you can find, but if none
4065 * found, the one we just pushed is fine. This results in at
4066 * any given moment at most one CRLF-capable layer being enabled
4067 * in the whole layer stack. */
4068 PerlIO *g = PerlIONext(f);
4070 PerlIOl *b = PerlIOBase(g);
4071 if (b && b->tab == &PerlIO_crlf) {
4072 if (!(b->flags & PERLIO_F_CRLF))
4073 b->flags |= PERLIO_F_CRLF;
4074 PerlIO_pop(aTHX_ f);
4085 PerlIOCrlf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4087 PerlIOCrlf *c = PerlIOSelf(f, PerlIOCrlf);
4092 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF))
4093 return PerlIOBuf_unread(aTHX_ f, vbuf, count);
4095 const STDCHAR *buf = (const STDCHAR *) vbuf + count;
4096 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4098 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
4103 if (!(PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4104 b->end = b->ptr = b->buf + b->bufsiz;
4105 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4106 b->posn -= b->bufsiz;
4108 while (count > 0 && b->ptr > b->buf) {
4111 if (b->ptr - 2 >= b->buf) {
4134 PerlIOCrlf_get_cnt(pTHX_ PerlIO *f)
4136 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4139 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
4140 PerlIOCrlf *c = PerlIOSelf(f, PerlIOCrlf);
4141 if ((PerlIOBase(f)->flags & PERLIO_F_CRLF) && (!c->nl || *c->nl == 0xd)) {
4142 STDCHAR *nl = (c->nl) ? c->nl : b->ptr;
4144 while (nl < b->end && *nl != 0xd)
4146 if (nl < b->end && *nl == 0xd) {
4148 if (nl + 1 < b->end) {
4155 * Not CR,LF but just CR
4163 * Blast - found CR as last char in buffer
4168 * They may not care, defer work as long as
4172 return (nl - b->ptr);
4176 b->ptr++; /* say we have read it as far as
4177 * flush() is concerned */
4178 b->buf++; /* Leave space in front of buffer */
4179 /* Note as we have moved buf up flush's
4181 will naturally make posn point at CR
4183 b->bufsiz--; /* Buffer is thus smaller */
4184 code = PerlIO_fill(f); /* Fetch some more */
4185 b->bufsiz++; /* Restore size for next time */
4186 b->buf--; /* Point at space */
4187 b->ptr = nl = b->buf; /* Which is what we hand
4189 *nl = 0xd; /* Fill in the CR */
4191 goto test; /* fill() call worked */
4193 * CR at EOF - just fall through
4195 /* Should we clear EOF though ??? */
4200 return (((c->nl) ? (c->nl + 1) : b->end) - b->ptr);
4206 PerlIOCrlf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
4208 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4209 PerlIOCrlf *c = PerlIOSelf(f, PerlIOCrlf);
4215 if (ptr == b->end && *c->nl == 0xd) {
4216 /* Defered CR at end of buffer case - we lied about count */
4228 * Test code - delete when it works ...
4230 IV flags = PerlIOBase(f)->flags;
4231 STDCHAR *chk = (c->nl) ? (c->nl+1) : b->end;
4232 if (ptr+cnt == c->nl && c->nl+1 == b->end && *c->nl == 0xd) {
4233 /* Defered CR at end of buffer case - we lied about count */
4239 Perl_croak(aTHX_ "ptr wrong %p != %p fl=%08" UVxf
4240 " nl=%p e=%p for %d", ptr, chk, flags, c->nl,
4248 * They have taken what we lied about
4256 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4260 PerlIOCrlf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4262 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF))
4263 return PerlIOBuf_write(aTHX_ f, vbuf, count);
4265 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4266 const STDCHAR *buf = (const STDCHAR *) vbuf;
4267 const STDCHAR *ebuf = buf + count;
4270 if (!(PerlIOBase(f)->flags & PERLIO_F_CANWRITE))
4272 while (buf < ebuf) {
4273 STDCHAR *eptr = b->buf + b->bufsiz;
4274 PerlIOBase(f)->flags |= PERLIO_F_WRBUF;
4275 while (buf < ebuf && b->ptr < eptr) {
4277 if ((b->ptr + 2) > eptr) {
4285 *(b->ptr)++ = 0xd; /* CR */
4286 *(b->ptr)++ = 0xa; /* LF */
4288 if (PerlIOBase(f)->flags & PERLIO_F_LINEBUF) {
4298 if (b->ptr >= eptr) {
4304 if (PerlIOBase(f)->flags & PERLIO_F_UNBUF)
4306 return (buf - (STDCHAR *) vbuf);
4311 PerlIOCrlf_flush(pTHX_ PerlIO *f)
4313 PerlIOCrlf *c = PerlIOSelf(f, PerlIOCrlf);
4318 return PerlIOBuf_flush(aTHX_ f);
4322 PerlIOCrlf_binmode(pTHX_ PerlIO *f)
4324 if ((PerlIOBase(f)->flags & PERLIO_F_CRLF)) {
4325 /* In text mode - flush any pending stuff and flip it */
4326 PerlIOBase(f)->flags &= ~PERLIO_F_CRLF;
4327 #ifndef PERLIO_USING_CRLF
4328 /* CRLF is unusual case - if this is just the :crlf layer pop it */
4329 if (PerlIOBase(f)->tab == &PerlIO_crlf) {
4330 PerlIO_pop(aTHX_ f);
4337 PerlIO_funcs PerlIO_crlf = {
4338 sizeof(PerlIO_funcs),
4341 PERLIO_K_BUFFERED | PERLIO_K_CANCRLF | PERLIO_K_RAW,
4343 PerlIOBuf_popped, /* popped */
4345 PerlIOCrlf_binmode, /* binmode */
4349 PerlIOBuf_read, /* generic read works with ptr/cnt lies
4351 PerlIOCrlf_unread, /* Put CR,LF in buffer for each '\n' */
4352 PerlIOCrlf_write, /* Put CR,LF in buffer for each '\n' */
4360 PerlIOBase_clearerr,
4361 PerlIOBase_setlinebuf,
4366 PerlIOCrlf_set_ptrcnt,
4370 /*--------------------------------------------------------------------------------------*/
4372 * mmap as "buffer" layer
4376 PerlIOBuf base; /* PerlIOBuf stuff */
4377 Mmap_t mptr; /* Mapped address */
4378 Size_t len; /* mapped length */
4379 STDCHAR *bbuf; /* malloced buffer if map fails */
4382 static size_t page_size = 0;
4385 PerlIOMmap_map(pTHX_ PerlIO *f)
4387 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4388 IV flags = PerlIOBase(f)->flags;
4392 if (flags & PERLIO_F_CANREAD) {
4393 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4394 int fd = PerlIO_fileno(f);
4396 code = Fstat(fd, &st);
4397 if (code == 0 && S_ISREG(st.st_mode)) {
4398 SSize_t len = st.st_size - b->posn;
4402 #if defined(HAS_SYSCONF) && (defined(_SC_PAGESIZE) || defined(_SC_PAGE_SIZE))
4404 SETERRNO(0, SS_NORMAL);
4405 # ifdef _SC_PAGESIZE
4406 page_size = sysconf(_SC_PAGESIZE);
4408 page_size = sysconf(_SC_PAGE_SIZE);
4410 if ((long) page_size < 0) {
4415 (void) SvUPGRADE(error, SVt_PV);
4416 msg = SvPVx(error, n_a);
4417 Perl_croak(aTHX_ "panic: sysconf: %s",
4422 "panic: sysconf: pagesize unknown");
4426 # ifdef HAS_GETPAGESIZE
4427 page_size = getpagesize();
4429 # if defined(I_SYS_PARAM) && defined(PAGESIZE)
4430 page_size = PAGESIZE; /* compiletime, bad */
4434 if ((IV) page_size <= 0)
4435 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 / page_size) * 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 *m = PerlIOSelf(f, PerlIOMmap);
4567 PerlIOBuf *b = &m->base;
4568 if (!b->buf || !(PerlIOBase(f)->flags & PERLIO_F_WRBUF)) {
4570 * No, or wrong sort of, buffer
4573 if (PerlIOMmap_unmap(aTHX_ f) != 0)
4577 * If unmap took the "buffer" see if we have one from before
4579 if (!b->buf && m->bbuf)
4582 PerlIOBuf_get_base(aTHX_ f);
4586 return PerlIOBuf_write(aTHX_ f, vbuf, count);
4590 PerlIOMmap_flush(pTHX_ PerlIO *f)
4592 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4593 PerlIOBuf *b = &m->base;
4594 IV code = PerlIOBuf_flush(aTHX_ f);
4596 * Now we are "synced" at PerlIOBuf level
4603 if (PerlIOMmap_unmap(aTHX_ f) != 0)
4608 * We seem to have a PerlIOBuf buffer which was not mapped
4609 * remember it in case we need one later
4618 PerlIOMmap_fill(pTHX_ PerlIO *f)
4620 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4621 IV code = PerlIO_flush(f);
4622 if (code == 0 && !b->buf) {
4623 code = PerlIOMmap_map(aTHX_ f);
4625 if (code == 0 && !(PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4626 code = PerlIOBuf_fill(aTHX_ f);
4632 PerlIOMmap_close(pTHX_ PerlIO *f)
4634 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4635 PerlIOBuf *b = &m->base;
4636 IV code = PerlIO_flush(f);
4640 b->ptr = b->end = b->buf;
4642 if (PerlIOBuf_close(aTHX_ f) != 0)
4648 PerlIOMmap_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
4650 return PerlIOBase_dup(aTHX_ f, o, param, flags);
4654 PerlIO_funcs PerlIO_mmap = {
4655 sizeof(PerlIO_funcs),
4658 PERLIO_K_BUFFERED|PERLIO_K_RAW,
4662 PerlIOBase_binmode, /* binmode */
4676 PerlIOBase_clearerr,
4677 PerlIOBase_setlinebuf,
4678 PerlIOMmap_get_base,
4682 PerlIOBuf_set_ptrcnt,
4685 #endif /* HAS_MMAP */
4688 Perl_PerlIO_stdin(pTHX)
4691 PerlIO_stdstreams(aTHX);
4693 return &PL_perlio[1];
4697 Perl_PerlIO_stdout(pTHX)
4700 PerlIO_stdstreams(aTHX);
4702 return &PL_perlio[2];
4706 Perl_PerlIO_stderr(pTHX)
4709 PerlIO_stdstreams(aTHX);
4711 return &PL_perlio[3];
4714 /*--------------------------------------------------------------------------------------*/
4717 PerlIO_getname(PerlIO *f, char *buf)
4722 bool exported = FALSE;
4723 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
4725 stdio = PerlIO_exportFILE(f,0);
4729 name = fgetname(stdio, buf);
4730 if (exported) PerlIO_releaseFILE(f,stdio);
4733 Perl_croak(aTHX_ "Don't know how to get file name");
4739 /*--------------------------------------------------------------------------------------*/
4741 * Functions which can be called on any kind of PerlIO implemented in
4745 #undef PerlIO_fdopen
4747 PerlIO_fdopen(int fd, const char *mode)
4750 return PerlIO_openn(aTHX_ Nullch, mode, fd, 0, 0, NULL, 0, NULL);
4755 PerlIO_open(const char *path, const char *mode)
4758 SV *name = sv_2mortal(newSVpvn(path, strlen(path)));
4759 return PerlIO_openn(aTHX_ Nullch, mode, -1, 0, 0, NULL, 1, &name);
4762 #undef Perlio_reopen
4764 PerlIO_reopen(const char *path, const char *mode, PerlIO *f)
4767 SV *name = sv_2mortal(newSVpvn(path, strlen(path)));
4768 return PerlIO_openn(aTHX_ Nullch, mode, -1, 0, 0, f, 1, &name);
4773 PerlIO_getc(PerlIO *f)
4777 SSize_t count = PerlIO_read(f, buf, 1);
4779 return (unsigned char) buf[0];
4784 #undef PerlIO_ungetc
4786 PerlIO_ungetc(PerlIO *f, int ch)
4791 if (PerlIO_unread(f, &buf, 1) == 1)
4799 PerlIO_putc(PerlIO *f, int ch)
4803 return PerlIO_write(f, &buf, 1);
4808 PerlIO_puts(PerlIO *f, const char *s)
4811 STRLEN len = strlen(s);
4812 return PerlIO_write(f, s, len);
4815 #undef PerlIO_rewind
4817 PerlIO_rewind(PerlIO *f)
4820 PerlIO_seek(f, (Off_t) 0, SEEK_SET);
4824 #undef PerlIO_vprintf
4826 PerlIO_vprintf(PerlIO *f, const char *fmt, va_list ap)
4829 SV *sv = newSVpvn("", 0);
4835 Perl_va_copy(ap, apc);
4836 sv_vcatpvf(sv, fmt, &apc);
4838 sv_vcatpvf(sv, fmt, &ap);
4841 wrote = PerlIO_write(f, s, len);
4846 #undef PerlIO_printf
4848 PerlIO_printf(PerlIO *f, const char *fmt, ...)
4853 result = PerlIO_vprintf(f, fmt, ap);
4858 #undef PerlIO_stdoutf
4860 PerlIO_stdoutf(const char *fmt, ...)
4866 result = PerlIO_vprintf(PerlIO_stdout(), fmt, ap);
4871 #undef PerlIO_tmpfile
4873 PerlIO_tmpfile(void)
4881 f = PerlIO_fdopen(fd, "w+b");
4883 # if defined(HAS_MKSTEMP) && ! defined(VMS) && ! defined(OS2)
4884 SV *sv = newSVpv("/tmp/PerlIO_XXXXXX", 0);
4887 * I have no idea how portable mkstemp() is ... NI-S
4889 fd = mkstemp(SvPVX(sv));
4891 f = PerlIO_fdopen(fd, "w+");
4893 PerlIOBase(f)->flags |= PERLIO_F_TEMP;
4894 PerlLIO_unlink(SvPVX(sv));
4897 # else /* !HAS_MKSTEMP, fallback to stdio tmpfile(). */
4898 FILE *stdio = PerlSIO_tmpfile();
4901 if ((f = PerlIO_push(aTHX_(PerlIO_allocate(aTHX)),
4902 &PerlIO_stdio, "w+", Nullsv))) {
4903 PerlIOStdio *s = PerlIOSelf(f, PerlIOStdio);
4909 # endif /* else HAS_MKSTEMP */
4910 #endif /* else WIN32 */
4917 #endif /* USE_SFIO */
4918 #endif /* PERLIO_IS_STDIO */
4920 /*======================================================================================*/
4922 * Now some functions in terms of above which may be needed even if we are
4923 * not in true PerlIO mode
4927 #undef PerlIO_setpos
4929 PerlIO_setpos(PerlIO *f, SV *pos)
4934 Off_t *posn = (Off_t *) SvPV(pos, len);
4935 if (f && len == sizeof(Off_t))
4936 return PerlIO_seek(f, *posn, SEEK_SET);
4938 SETERRNO(EINVAL, SS_IVCHAN);
4942 #undef PerlIO_setpos
4944 PerlIO_setpos(PerlIO *f, SV *pos)
4949 Fpos_t *fpos = (Fpos_t *) SvPV(pos, len);
4950 if (f && len == sizeof(Fpos_t)) {
4951 #if defined(USE_64_BIT_STDIO) && defined(USE_FSETPOS64)
4952 return fsetpos64(f, fpos);
4954 return fsetpos(f, fpos);
4958 SETERRNO(EINVAL, SS_IVCHAN);
4964 #undef PerlIO_getpos
4966 PerlIO_getpos(PerlIO *f, SV *pos)
4969 Off_t posn = PerlIO_tell(f);
4970 sv_setpvn(pos, (char *) &posn, sizeof(posn));
4971 return (posn == (Off_t) - 1) ? -1 : 0;
4974 #undef PerlIO_getpos
4976 PerlIO_getpos(PerlIO *f, SV *pos)
4981 #if defined(USE_64_BIT_STDIO) && defined(USE_FSETPOS64)
4982 code = fgetpos64(f, &fpos);
4984 code = fgetpos(f, &fpos);
4986 sv_setpvn(pos, (char *) &fpos, sizeof(fpos));
4991 #if (defined(PERLIO_IS_STDIO) || !defined(USE_SFIO)) && !defined(HAS_VPRINTF)
4994 vprintf(char *pat, char *args)
4996 _doprnt(pat, args, stdout);
4997 return 0; /* wrong, but perl doesn't use the return
5002 vfprintf(FILE *fd, char *pat, char *args)
5004 _doprnt(pat, args, fd);
5005 return 0; /* wrong, but perl doesn't use the return
5011 #ifndef PerlIO_vsprintf
5013 PerlIO_vsprintf(char *s, int n, const char *fmt, va_list ap)
5015 int val = vsprintf(s, fmt, ap);
5017 if (strlen(s) >= (STRLEN) n) {
5019 (void) PerlIO_puts(Perl_error_log,
5020 "panic: sprintf overflow - memory corrupted!\n");
5028 #ifndef PerlIO_sprintf
5030 PerlIO_sprintf(char *s, int n, const char *fmt, ...)
5035 result = PerlIO_vsprintf(s, n, fmt, ap);