2 * perlio.c Copyright (c) 1996-2002, Nick Ing-Simmons You may distribute
3 * under the terms of either the GNU General Public License or the
4 * Artistic License, as specified in the README file.
8 * Hour after hour for nearly three weary days he had jogged up and down,
9 * over passes, and through long dales, and across many streams.
13 * If we have ActivePerl-like PERL_IMPLICIT_SYS then we need a dTHX to get
14 * at the dispatch tables, even when we do not need it for other reasons.
15 * Invent a dSYS macro to abstract this out
17 #ifdef PERL_IMPLICIT_SYS
30 #define PERLIO_NOT_STDIO 0
31 #if !defined(PERLIO_IS_STDIO) && !defined(USE_SFIO)
37 * This file provides those parts of PerlIO abstraction
38 * which are not #defined in perlio.h.
39 * Which these are depends on various Configure #ifdef's
43 #define PERL_IN_PERLIO_C
46 #ifdef PERL_IMPLICIT_CONTEXT
54 perlsio_binmode(FILE *fp, int iotype, int mode)
57 * This used to be contents of do_binmode in doio.c
60 # if defined(atarist) || defined(__MINT__)
63 ((FILE *) fp)->_flag |= _IOBIN;
65 ((FILE *) fp)->_flag &= ~_IOBIN;
72 if (PerlLIO_setmode(fp, mode) != -1) {
74 if (PerlLIO_setmode(fileno(fp), mode) != -1) {
76 # if defined(WIN32) && defined(__BORLANDC__)
78 * The translation mode of the stream is maintained independent of
79 * the translation mode of the fd in the Borland RTL (heavy
80 * digging through their runtime sources reveal). User has to set
81 * the mode explicitly for the stream (though they don't document
82 * this anywhere). GSAR 97-5-24
96 # if defined(USEMYBINMODE)
98 if (my_binmode(fp, iotype, mode) != FALSE)
109 #define O_ACCMODE 3 /* Assume traditional implementation */
113 PerlIO_intmode2str(int rawmode, char *mode, int *writing)
115 int result = rawmode & O_ACCMODE;
120 ptype = IoTYPE_RDONLY;
123 ptype = IoTYPE_WRONLY;
131 *writing = (result != O_RDONLY);
133 if (result == O_RDONLY) {
137 else if (rawmode & O_APPEND) {
139 if (result != O_WRONLY)
144 if (result == O_WRONLY)
151 if (rawmode & O_BINARY)
157 #ifndef PERLIO_LAYERS
159 PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode, const char *names)
161 if (!names || !*names
162 || strEQ(names, ":crlf")
163 || strEQ(names, ":raw")
164 || strEQ(names, ":bytes")
168 Perl_croak(aTHX_ "Cannot apply \"%s\" in non-PerlIO perl", names);
176 PerlIO_destruct(pTHX)
181 PerlIO_binmode(pTHX_ PerlIO *fp, int iotype, int mode, const char *names)
186 return perlsio_binmode(fp, iotype, mode);
191 PerlIO_fdupopen(pTHX_ PerlIO *f, CLONE_PARAMS *param, int flags)
196 #ifdef PERL_IMPLICIT_SYS
197 return PerlSIO_fdupopen(f);
200 return win32_fdupopen(f);
203 int fd = PerlLIO_dup(PerlIO_fileno(f));
206 int omode = fcntl(fd, F_GETFL);
208 omode = djgpp_get_stream_mode(f);
210 PerlIO_intmode2str(omode,mode,NULL);
211 /* the r+ is a hack */
212 return PerlIO_fdopen(fd, mode);
217 SETERRNO(EBADF, SS_IVCHAN);
227 * De-mux PerlIO_openn() into fdopen, freopen and fopen type entries
231 PerlIO_openn(pTHX_ const char *layers, const char *mode, int fd,
232 int imode, int perm, PerlIO *old, int narg, SV **args)
236 Perl_croak(aTHX_ "More than one argument to open");
238 if (*args == &PL_sv_undef)
239 return PerlIO_tmpfile();
241 char *name = SvPV_nolen(*args);
243 fd = PerlLIO_open3(name, imode, perm);
245 return PerlIO_fdopen(fd, (char *) mode + 1);
248 return PerlIO_reopen(name, mode, old);
251 return PerlIO_open(name, mode);
256 return PerlIO_fdopen(fd, (char *) mode);
261 XS(XS_PerlIO__Layer__find)
265 Perl_croak(aTHX_ "Usage class->find(name[,load])");
267 char *name = SvPV_nolen(ST(1));
268 ST(0) = (strEQ(name, "crlf")
269 || strEQ(name, "raw")) ? &PL_sv_yes : &PL_sv_undef;
276 Perl_boot_core_PerlIO(pTHX)
278 newXS("PerlIO::Layer::find", XS_PerlIO__Layer__find, __FILE__);
284 #ifdef PERLIO_IS_STDIO
290 * Does nothing (yet) except force this file to be included in perl
291 * binary. That allows this file to force inclusion of other functions
292 * that may be required by loadable extensions e.g. for
293 * FileHandle::tmpfile
297 #undef PerlIO_tmpfile
304 #else /* PERLIO_IS_STDIO */
312 * This section is just to make sure these functions get pulled in from
316 #undef PerlIO_tmpfile
327 * Force this file to be included in perl binary. Which allows this
328 * file to force inclusion of other functions that may be required by
329 * loadable extensions e.g. for FileHandle::tmpfile
333 * Hack sfio does its own 'autoflush' on stdout in common cases. Flush
334 * results in a lot of lseek()s to regular files and lot of small
337 sfset(sfstdout, SF_SHARE, 0);
340 /* This is not the reverse of PerlIO_exportFILE(), PerlIO_releaseFILE() is. */
342 PerlIO_importFILE(FILE *stdio, const char *mode)
344 int fd = fileno(stdio);
345 if (!mode || !*mode) {
348 return PerlIO_fdopen(fd, mode);
352 PerlIO_findFILE(PerlIO *pio)
354 int fd = PerlIO_fileno(pio);
355 FILE *f = fdopen(fd, "r+");
357 if (!f && errno == EINVAL)
359 if (!f && errno == EINVAL)
366 /*======================================================================================*/
368 * Implement all the PerlIO interface ourselves.
374 * We _MUST_ have <unistd.h> if we are using lseek() and may have large
381 #include <sys/mman.h>
385 void PerlIO_debug(const char *fmt, ...)
386 __attribute__ ((format(__printf__, 1, 2)));
389 PerlIO_debug(const char *fmt, ...)
396 char *s = PerlEnv_getenv("PERLIO_DEBUG");
398 dbg = PerlLIO_open3(s, O_WRONLY | O_CREAT | O_APPEND, 0666);
405 /* Use fixed buffer as sv_catpvf etc. needs SVs */
409 s = CopFILE(PL_curcop);
412 sprintf(buffer, "%s:%" IVdf " ", s, (IV) CopLINE(PL_curcop));
413 len = strlen(buffer);
414 vsprintf(buffer+len, fmt, ap);
415 PerlLIO_write(dbg, buffer, strlen(buffer));
417 SV *sv = newSVpvn("", 0);
420 s = CopFILE(PL_curcop);
423 Perl_sv_catpvf(aTHX_ sv, "%s:%" IVdf " ", s,
424 (IV) CopLINE(PL_curcop));
425 Perl_sv_vcatpvf(aTHX_ sv, fmt, &ap);
428 PerlLIO_write(dbg, s, len);
435 /*--------------------------------------------------------------------------------------*/
438 * Inner level routines
442 * Table of pointers to the PerlIO structs (malloc'ed)
444 #define PERLIO_TABLE_SIZE 64
447 PerlIO_allocate(pTHX)
450 * Find a free slot in the table, allocating new table as necessary
455 while ((f = *last)) {
457 last = (PerlIO **) (f);
458 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
464 Newz('I',f,PERLIO_TABLE_SIZE,PerlIO);
472 #undef PerlIO_fdupopen
474 PerlIO_fdupopen(pTHX_ PerlIO *f, CLONE_PARAMS *param, int flags)
476 if (PerlIOValid(f)) {
477 PerlIO_funcs *tab = PerlIOBase(f)->tab;
479 PerlIO_debug("fdupopen f=%p param=%p\n",(void*)f,(void*)param);
480 new = (*tab->Dup)(aTHX_ PerlIO_allocate(aTHX),f,param, flags);
484 SETERRNO(EBADF, SS_IVCHAN);
490 PerlIO_cleantable(pTHX_ PerlIO **tablep)
492 PerlIO *table = *tablep;
495 PerlIO_cleantable(aTHX_(PerlIO **) & (table[0]));
496 for (i = PERLIO_TABLE_SIZE - 1; i > 0; i--) {
497 PerlIO *f = table + i;
509 PerlIO_list_alloc(pTHX)
512 Newz('L', list, 1, PerlIO_list_t);
518 PerlIO_list_free(pTHX_ PerlIO_list_t *list)
521 if (--list->refcnt == 0) {
524 for (i = 0; i < list->cur; i++) {
525 if (list->array[i].arg)
526 SvREFCNT_dec(list->array[i].arg);
528 Safefree(list->array);
536 PerlIO_list_push(pTHX_ PerlIO_list_t *list, PerlIO_funcs *funcs, SV *arg)
539 if (list->cur >= list->len) {
542 Renew(list->array, list->len, PerlIO_pair_t);
544 New('l', list->array, list->len, PerlIO_pair_t);
546 p = &(list->array[list->cur++]);
548 if ((p->arg = arg)) {
554 PerlIO_clone_list(pTHX_ PerlIO_list_t *proto, CLONE_PARAMS *param)
556 PerlIO_list_t *list = (PerlIO_list_t *) NULL;
559 list = PerlIO_list_alloc(aTHX);
560 for (i=0; i < proto->cur; i++) {
562 if (proto->array[i].arg)
563 arg = PerlIO_sv_dup(aTHX_ proto->array[i].arg,param);
564 PerlIO_list_push(aTHX_ list, proto->array[i].funcs, arg);
571 PerlIO_clone(pTHX_ PerlInterpreter *proto, CLONE_PARAMS *param)
574 PerlIO **table = &proto->Iperlio;
577 PL_known_layers = PerlIO_clone_list(aTHX_ proto->Iknown_layers, param);
578 PL_def_layerlist = PerlIO_clone_list(aTHX_ proto->Idef_layerlist, param);
579 PerlIO_allocate(aTHX); /* root slot is never used */
580 PerlIO_debug("Clone %p from %p\n",aTHX,proto);
581 while ((f = *table)) {
583 table = (PerlIO **) (f++);
584 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
586 (void) fp_dup(f, 0, param);
595 PerlIO_destruct(pTHX)
597 PerlIO **table = &PL_perlio;
600 PerlIO_debug("Destruct %p\n",aTHX);
602 while ((f = *table)) {
604 table = (PerlIO **) (f++);
605 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
609 if (l->tab->kind & PERLIO_K_DESTRUCT) {
610 PerlIO_debug("Destruct popping %s\n", l->tab->name);
624 PerlIO_pop(pTHX_ PerlIO *f)
628 PerlIO_debug("PerlIO_pop f=%p %s\n", (void*)f, l->tab->name);
629 if (l->tab->Popped) {
631 * If popped returns non-zero do not free its layer structure
632 * it has either done so itself, or it is shared and still in
635 if ((*l->tab->Popped) (aTHX_ f) != 0)
643 /* Return as an array the stack of layers on a filehandle. Note that
644 * the stack is returned top-first in the array, and there are three
645 * times as many array elements as there are layers in the stack: the
646 * first element of a layer triplet is the name, the second one is the
647 * arguments, and the third one is the flags. */
650 PerlIO_get_layers(pTHX_ PerlIO *f)
654 if (PerlIOValid(f)) {
655 PerlIOl *l = PerlIOBase(f);
658 SV *name = l->tab && l->tab->name ?
659 newSVpv(l->tab->name, 0) : &PL_sv_undef;
660 SV *arg = l->tab && l->tab->Getarg ?
661 (*l->tab->Getarg)(aTHX_ &l, 0, 0) : &PL_sv_undef;
664 av_push(av, newSViv((IV)l->flags));
672 /*--------------------------------------------------------------------------------------*/
674 * XS Interface for perl code
678 PerlIO_find_layer(pTHX_ const char *name, STRLEN len, int load)
681 if ((SSize_t) len <= 0)
683 for (i = 0; i < PL_known_layers->cur; i++) {
684 PerlIO_funcs *f = PL_known_layers->array[i].funcs;
685 if (memEQ(f->name, name, len)) {
686 PerlIO_debug("%.*s => %p\n", (int) len, name, (void*)f);
690 if (load && PL_subname && PL_def_layerlist
691 && PL_def_layerlist->cur >= 2) {
692 if (PL_in_load_module) {
693 Perl_croak(aTHX_ "Recursive call to Perl_load_module in PerlIO_find_layer");
696 SV *pkgsv = newSVpvn("PerlIO", 6);
697 SV *layer = newSVpvn(name, len);
698 CV *cv = get_cv("PerlIO::Layer::NoWarnings", FALSE);
700 SAVEINT(PL_in_load_module);
702 SAVESPTR(PL_warnhook);
703 PL_warnhook = (SV *) cv;
707 * The two SVs are magically freed by load_module
709 Perl_load_module(aTHX_ 0, pkgsv, Nullsv, layer, Nullsv);
712 return PerlIO_find_layer(aTHX_ name, len, 0);
715 PerlIO_debug("Cannot find %.*s\n", (int) len, name);
719 #ifdef USE_ATTRIBUTES_FOR_PERLIO
722 perlio_mg_set(pTHX_ SV *sv, MAGIC *mg)
725 IO *io = GvIOn((GV *) SvRV(sv));
726 PerlIO *ifp = IoIFP(io);
727 PerlIO *ofp = IoOFP(io);
728 Perl_warn(aTHX_ "set %" SVf " %p %p %p", sv, io, ifp, ofp);
734 perlio_mg_get(pTHX_ SV *sv, MAGIC *mg)
737 IO *io = GvIOn((GV *) SvRV(sv));
738 PerlIO *ifp = IoIFP(io);
739 PerlIO *ofp = IoOFP(io);
740 Perl_warn(aTHX_ "get %" SVf " %p %p %p", sv, io, ifp, ofp);
746 perlio_mg_clear(pTHX_ SV *sv, MAGIC *mg)
748 Perl_warn(aTHX_ "clear %" SVf, sv);
753 perlio_mg_free(pTHX_ SV *sv, MAGIC *mg)
755 Perl_warn(aTHX_ "free %" SVf, sv);
759 MGVTBL perlio_vtab = {
767 XS(XS_io_MODIFY_SCALAR_ATTRIBUTES)
770 SV *sv = SvRV(ST(1));
775 sv_magic(sv, (SV *) av, PERL_MAGIC_ext, NULL, 0);
777 mg = mg_find(sv, PERL_MAGIC_ext);
778 mg->mg_virtual = &perlio_vtab;
780 Perl_warn(aTHX_ "attrib %" SVf, sv);
781 for (i = 2; i < items; i++) {
783 const char *name = SvPV(ST(i), len);
784 SV *layer = PerlIO_find_layer(aTHX_ name, len, 1);
786 av_push(av, SvREFCNT_inc(layer));
797 #endif /* USE_ATTIBUTES_FOR_PERLIO */
800 PerlIO_tab_sv(pTHX_ PerlIO_funcs *tab)
802 HV *stash = gv_stashpv("PerlIO::Layer", TRUE);
803 SV *sv = sv_bless(newRV_noinc(newSViv(PTR2IV(tab))), stash);
807 XS(XS_PerlIO__Layer__NoWarnings)
809 /* This is used as a %SIG{__WARN__} handler to supress warnings
810 during loading of layers.
814 PerlIO_debug("warning:%s\n",SvPV_nolen(ST(0)));
818 XS(XS_PerlIO__Layer__find)
822 Perl_croak(aTHX_ "Usage class->find(name[,load])");
825 char *name = SvPV(ST(1), len);
826 bool load = (items > 2) ? SvTRUE(ST(2)) : 0;
827 PerlIO_funcs *layer = PerlIO_find_layer(aTHX_ name, len, load);
829 (layer) ? sv_2mortal(PerlIO_tab_sv(aTHX_ layer)) :
836 PerlIO_define_layer(pTHX_ PerlIO_funcs *tab)
838 if (!PL_known_layers)
839 PL_known_layers = PerlIO_list_alloc(aTHX);
840 PerlIO_list_push(aTHX_ PL_known_layers, tab, Nullsv);
841 PerlIO_debug("define %s %p\n", tab->name, (void*)tab);
845 PerlIO_parse_layers(pTHX_ PerlIO_list_t *av, const char *names)
848 const char *s = names;
850 while (isSPACE(*s) || *s == ':')
855 const char *as = Nullch;
857 if (!isIDFIRST(*s)) {
859 * Message is consistent with how attribute lists are
860 * passed. Even though this means "foo : : bar" is
861 * seen as an invalid separator character.
863 char q = ((*s == '\'') ? '"' : '\'');
864 if (ckWARN(WARN_LAYER))
865 Perl_warner(aTHX_ packWARN(WARN_LAYER),
866 "perlio: invalid separator character %c%c%c in layer specification list %s",
868 SETERRNO(EINVAL, LIB_INVARG);
873 } while (isALNUM(*e));
889 * It's a nul terminated string, not allowed
890 * to \ the terminating null. Anything other
891 * character is passed over.
901 if (ckWARN(WARN_LAYER))
902 Perl_warner(aTHX_ packWARN(WARN_LAYER),
903 "perlio: argument list not closed for layer \"%.*s\"",
915 bool warn_layer = ckWARN(WARN_LAYER);
916 PerlIO_funcs *layer =
917 PerlIO_find_layer(aTHX_ s, llen, 1);
919 PerlIO_list_push(aTHX_ av, layer,
926 Perl_warner(aTHX_ packWARN(WARN_LAYER), "perlio: unknown layer \"%.*s\"",
939 PerlIO_default_buffer(pTHX_ PerlIO_list_t *av)
941 PerlIO_funcs *tab = &PerlIO_perlio;
942 #ifdef PERLIO_USING_CRLF
945 if (PerlIO_stdio.Set_ptrcnt)
948 PerlIO_debug("Pushing %s\n", tab->name);
949 PerlIO_list_push(aTHX_ av, PerlIO_find_layer(aTHX_ tab->name, 0, 0),
954 PerlIO_arg_fetch(PerlIO_list_t *av, IV n)
956 return av->array[n].arg;
960 PerlIO_layer_fetch(pTHX_ PerlIO_list_t *av, IV n, PerlIO_funcs *def)
962 if (n >= 0 && n < av->cur) {
963 PerlIO_debug("Layer %" IVdf " is %s\n", n,
964 av->array[n].funcs->name);
965 return av->array[n].funcs;
968 Perl_croak(aTHX_ "panic: PerlIO layer array corrupt");
973 PerlIOPop_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
975 if (PerlIOValid(f)) {
983 PerlIO_funcs PerlIO_remove = {
984 sizeof(PerlIO_funcs),
987 PERLIO_K_DUMMY | PERLIO_K_UTF8,
1005 NULL, /* get_base */
1006 NULL, /* get_bufsiz */
1009 NULL, /* set_ptrcnt */
1013 PerlIO_default_layers(pTHX)
1015 if (!PL_def_layerlist) {
1016 const char *s = (PL_tainting) ? Nullch : PerlEnv_getenv("PERLIO");
1017 PerlIO_funcs *osLayer = &PerlIO_unix;
1018 PL_def_layerlist = PerlIO_list_alloc(aTHX);
1019 PerlIO_define_layer(aTHX_ & PerlIO_unix);
1020 #if defined(WIN32) && !defined(UNDER_CE)
1021 PerlIO_define_layer(aTHX_ & PerlIO_win32);
1023 osLayer = &PerlIO_win32;
1026 PerlIO_define_layer(aTHX_ & PerlIO_raw);
1027 PerlIO_define_layer(aTHX_ & PerlIO_perlio);
1028 PerlIO_define_layer(aTHX_ & PerlIO_stdio);
1029 PerlIO_define_layer(aTHX_ & PerlIO_crlf);
1031 PerlIO_define_layer(aTHX_ & PerlIO_mmap);
1033 PerlIO_define_layer(aTHX_ & PerlIO_utf8);
1034 PerlIO_define_layer(aTHX_ & PerlIO_remove);
1035 PerlIO_define_layer(aTHX_ & PerlIO_byte);
1036 PerlIO_list_push(aTHX_ PL_def_layerlist,
1037 PerlIO_find_layer(aTHX_ osLayer->name, 0, 0),
1040 PerlIO_parse_layers(aTHX_ PL_def_layerlist, s);
1043 PerlIO_default_buffer(aTHX_ PL_def_layerlist);
1046 if (PL_def_layerlist->cur < 2) {
1047 PerlIO_default_buffer(aTHX_ PL_def_layerlist);
1049 return PL_def_layerlist;
1053 Perl_boot_core_PerlIO(pTHX)
1055 #ifdef USE_ATTRIBUTES_FOR_PERLIO
1056 newXS("io::MODIFY_SCALAR_ATTRIBUTES", XS_io_MODIFY_SCALAR_ATTRIBUTES,
1059 newXS("PerlIO::Layer::find", XS_PerlIO__Layer__find, __FILE__);
1060 newXS("PerlIO::Layer::NoWarnings", XS_PerlIO__Layer__NoWarnings, __FILE__);
1064 PerlIO_default_layer(pTHX_ I32 n)
1066 PerlIO_list_t *av = PerlIO_default_layers(aTHX);
1069 return PerlIO_layer_fetch(aTHX_ av, n, &PerlIO_stdio);
1072 #define PerlIO_default_top() PerlIO_default_layer(aTHX_ -1)
1073 #define PerlIO_default_btm() PerlIO_default_layer(aTHX_ 0)
1076 PerlIO_stdstreams(pTHX)
1079 PerlIO_allocate(aTHX);
1080 PerlIO_fdopen(0, "Ir" PERLIO_STDTEXT);
1081 PerlIO_fdopen(1, "Iw" PERLIO_STDTEXT);
1082 PerlIO_fdopen(2, "Iw" PERLIO_STDTEXT);
1087 PerlIO_push(pTHX_ PerlIO *f, PerlIO_funcs *tab, const char *mode, SV *arg)
1089 if (tab->fsize != sizeof(PerlIO_funcs)) {
1091 Perl_croak(aTHX_ "Layer does not match this perl");
1095 if (tab->size < sizeof(PerlIOl)) {
1098 /* Real layer with a data area */
1099 Newc('L',l,tab->size,char,PerlIOl);
1101 Zero(l, tab->size, char);
1105 PerlIO_debug("PerlIO_push f=%p %s %s %p\n", (void*)f, tab->name,
1106 (mode) ? mode : "(Null)", (void*)arg);
1107 if ((*l->tab->Pushed) (aTHX_ f, mode, arg, tab) != 0) {
1108 PerlIO_pop(aTHX_ f);
1114 /* Pseudo-layer where push does its own stack adjust */
1115 PerlIO_debug("PerlIO_push f=%p %s %s %p\n", (void*)f, tab->name,
1116 (mode) ? mode : "(Null)", (void*)arg);
1117 if ((*tab->Pushed) (aTHX_ f, mode, arg, tab) != 0) {
1125 PerlIOBase_binmode(pTHX_ PerlIO *f)
1127 if (PerlIOValid(f)) {
1128 /* Is layer suitable for raw stream ? */
1129 if (PerlIOBase(f)->tab->kind & PERLIO_K_RAW) {
1130 /* Yes - turn off UTF-8-ness, to undo UTF-8 locale effects */
1131 PerlIOBase(f)->flags &= ~PERLIO_F_UTF8;
1134 /* Not suitable - pop it */
1135 PerlIO_pop(aTHX_ f);
1143 PerlIORaw_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1146 if (PerlIOValid(f)) {
1151 * Strip all layers that are not suitable for a raw stream
1154 while (t && (l = *t)) {
1155 if (l->tab->Binmode) {
1156 /* Has a handler - normal case */
1157 if ((*l->tab->Binmode)(aTHX_ f) == 0) {
1159 /* Layer still there - move down a layer */
1168 /* No handler - pop it */
1169 PerlIO_pop(aTHX_ t);
1172 if (PerlIOValid(f)) {
1173 PerlIO_debug(":raw f=%p :%s\n", (void*)f, PerlIOBase(f)->tab->name);
1181 PerlIO_apply_layera(pTHX_ PerlIO *f, const char *mode,
1182 PerlIO_list_t *layers, IV n, IV max)
1186 PerlIO_funcs *tab = PerlIO_layer_fetch(aTHX_ layers, n, NULL);
1188 if (!PerlIO_push(aTHX_ f, tab, mode, PerlIOArg)) {
1199 PerlIO_apply_layers(pTHX_ PerlIO *f, const char *mode, const char *names)
1203 PerlIO_list_t *layers = PerlIO_list_alloc(aTHX);
1204 code = PerlIO_parse_layers(aTHX_ layers, names);
1206 code = PerlIO_apply_layera(aTHX_ f, mode, layers, 0, layers->cur);
1208 PerlIO_list_free(aTHX_ layers);
1214 /*--------------------------------------------------------------------------------------*/
1216 * Given the abstraction above the public API functions
1220 PerlIO_binmode(pTHX_ PerlIO *f, int iotype, int mode, const char *names)
1222 PerlIO_debug("PerlIO_binmode f=%p %s %c %x %s\n",
1223 (void*)f, PerlIOBase(f)->tab->name, iotype, mode,
1224 (names) ? names : "(Null)");
1226 /* Do not flush etc. if (e.g.) switching encodings.
1227 if a pushed layer knows it needs to flush lower layers
1228 (for example :unix which is never going to call them)
1229 it can do the flush when it is pushed.
1231 return PerlIO_apply_layers(aTHX_ f, NULL, names) == 0 ? TRUE : FALSE;
1234 /* Fake 5.6 legacy of using this call to turn ON O_TEXT */
1235 #ifdef PERLIO_USING_CRLF
1236 /* Legacy binmode only has meaning if O_TEXT has a value distinct from
1237 O_BINARY so we can look for it in mode.
1239 if (!(mode & O_BINARY)) {
1241 /* FIXME?: Looking down the layer stack seems wrong,
1242 but is a way of reaching past (say) an encoding layer
1243 to flip CRLF-ness of the layer(s) below
1246 /* Perhaps we should turn on bottom-most aware layer
1247 e.g. Ilya's idea that UNIX TTY could serve
1249 if (PerlIOBase(f)->tab->kind & PERLIO_K_CANCRLF) {
1250 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF)) {
1251 /* Not in text mode - flush any pending stuff and flip it */
1253 PerlIOBase(f)->flags |= PERLIO_F_CRLF;
1255 /* Only need to turn it on in one layer so we are done */
1260 /* Not finding a CRLF aware layer presumably means we are binary
1261 which is not what was requested - so we failed
1262 We _could_ push :crlf layer but so could caller
1267 /* Legacy binmode is now _defined_ as being equivalent to pushing :raw
1268 So code that used to be here is now in PerlIORaw_pushed().
1270 return PerlIO_push(aTHX_ f, &PerlIO_raw, Nullch, Nullsv) ? TRUE : FALSE;
1275 PerlIO__close(pTHX_ PerlIO *f)
1278 return (*PerlIOBase(f)->tab->Close) (aTHX_ f);
1280 SETERRNO(EBADF, SS_IVCHAN);
1286 Perl_PerlIO_close(pTHX_ PerlIO *f)
1289 if (PerlIOValid(f)) {
1290 code = (*PerlIOBase(f)->tab->Close) (aTHX_ f);
1292 PerlIO_pop(aTHX_ f);
1299 Perl_PerlIO_fileno(pTHX_ PerlIO *f)
1302 return (*PerlIOBase(f)->tab->Fileno) (aTHX_ f);
1304 SETERRNO(EBADF, SS_IVCHAN);
1310 PerlIO_context_layers(pTHX_ const char *mode)
1312 const char *type = NULL;
1314 * Need to supply default layer info from open.pm
1317 SV *layers = PL_curcop->cop_io;
1320 type = SvPV(layers, len);
1321 if (type && mode[0] != 'r') {
1323 * Skip to write part
1325 const char *s = strchr(type, 0);
1326 if (s && (STRLEN)(s - type) < len) {
1335 static PerlIO_funcs *
1336 PerlIO_layer_from_ref(pTHX_ SV *sv)
1339 * For any scalar type load the handler which is bundled with perl
1341 if (SvTYPE(sv) < SVt_PVAV)
1342 return PerlIO_find_layer(aTHX_ "scalar", 6, 1);
1345 * For other types allow if layer is known but don't try and load it
1347 switch (SvTYPE(sv)) {
1349 return PerlIO_find_layer(aTHX_ "Array", 5, 0);
1351 return PerlIO_find_layer(aTHX_ "Hash", 4, 0);
1353 return PerlIO_find_layer(aTHX_ "Code", 4, 0);
1355 return PerlIO_find_layer(aTHX_ "Glob", 4, 0);
1361 PerlIO_resolve_layers(pTHX_ const char *layers,
1362 const char *mode, int narg, SV **args)
1364 PerlIO_list_t *def = PerlIO_default_layers(aTHX);
1367 PerlIO_stdstreams(aTHX);
1371 * If it is a reference but not an object see if we have a handler
1374 if (SvROK(arg) && !sv_isobject(arg)) {
1375 PerlIO_funcs *handler = PerlIO_layer_from_ref(aTHX_ SvRV(arg));
1377 def = PerlIO_list_alloc(aTHX);
1378 PerlIO_list_push(aTHX_ def, handler, &PL_sv_undef);
1382 * Don't fail if handler cannot be found :via(...) etc. may do
1383 * something sensible else we will just stringfy and open
1389 layers = PerlIO_context_layers(aTHX_ mode);
1390 if (layers && *layers) {
1394 av = PerlIO_list_alloc(aTHX);
1395 for (i = 0; i < def->cur; i++) {
1396 PerlIO_list_push(aTHX_ av, def->array[i].funcs,
1403 if (PerlIO_parse_layers(aTHX_ av, layers) == 0) {
1407 PerlIO_list_free(aTHX_ av);
1408 return (PerlIO_list_t *) NULL;
1419 PerlIO_openn(pTHX_ const char *layers, const char *mode, int fd,
1420 int imode, int perm, PerlIO *f, int narg, SV **args)
1422 if (!f && narg == 1 && *args == &PL_sv_undef) {
1423 if ((f = PerlIO_tmpfile())) {
1425 layers = PerlIO_context_layers(aTHX_ mode);
1426 if (layers && *layers)
1427 PerlIO_apply_layers(aTHX_ f, mode, layers);
1431 PerlIO_list_t *layera = NULL;
1433 PerlIO_funcs *tab = NULL;
1434 if (PerlIOValid(f)) {
1436 * This is "reopen" - it is not tested as perl does not use it
1440 layera = PerlIO_list_alloc(aTHX);
1442 SV *arg = (l->tab->Getarg)
1443 ? (*l->tab->Getarg) (aTHX_ &l, NULL, 0)
1445 PerlIO_list_push(aTHX_ layera, l->tab, arg);
1446 l = *PerlIONext(&l);
1450 layera = PerlIO_resolve_layers(aTHX_ layers, mode, narg, args);
1456 * Start at "top" of layer stack
1458 n = layera->cur - 1;
1460 PerlIO_funcs *t = PerlIO_layer_fetch(aTHX_ layera, n, NULL);
1469 * Found that layer 'n' can do opens - call it
1471 if (narg > 1 && !(tab->kind & PERLIO_K_MULTIARG)) {
1472 Perl_croak(aTHX_ "More than one argument to open(,':%s')",tab->name);
1474 PerlIO_debug("openn(%s,'%s','%s',%d,%x,%o,%p,%d,%p)\n",
1475 tab->name, layers, mode, fd, imode, perm,
1476 (void*)f, narg, (void*)args);
1477 f = (*tab->Open) (aTHX_ tab, layera, n, mode, fd, imode, perm,
1480 if (n + 1 < layera->cur) {
1482 * More layers above the one that we used to open -
1485 if (PerlIO_apply_layera(aTHX_ f, mode, layera, n + 1, layera->cur) != 0) {
1486 /* If pushing layers fails close the file */
1493 PerlIO_list_free(aTHX_ layera);
1500 Perl_PerlIO_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
1503 return (*PerlIOBase(f)->tab->Read) (aTHX_ f, vbuf, count);
1505 SETERRNO(EBADF, SS_IVCHAN);
1511 Perl_PerlIO_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
1514 return (*PerlIOBase(f)->tab->Unread) (aTHX_ f, vbuf, count);
1516 SETERRNO(EBADF, SS_IVCHAN);
1522 Perl_PerlIO_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
1525 return (*PerlIOBase(f)->tab->Write) (aTHX_ f, vbuf, count);
1527 SETERRNO(EBADF, SS_IVCHAN);
1533 Perl_PerlIO_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
1536 return (*PerlIOBase(f)->tab->Seek) (aTHX_ f, offset, whence);
1538 SETERRNO(EBADF, SS_IVCHAN);
1544 Perl_PerlIO_tell(pTHX_ PerlIO *f)
1547 return (*PerlIOBase(f)->tab->Tell) (aTHX_ f);
1549 SETERRNO(EBADF, SS_IVCHAN);
1555 Perl_PerlIO_flush(pTHX_ PerlIO *f)
1559 PerlIO_funcs *tab = PerlIOBase(f)->tab;
1560 if (tab && tab->Flush) {
1561 return (*tab->Flush) (aTHX_ f);
1564 PerlIO_debug("Cannot flush f=%p :%s\n", (void*)f, tab->name);
1565 SETERRNO(EBADF, SS_IVCHAN);
1570 PerlIO_debug("Cannot flush f=%p\n", (void*)f);
1571 SETERRNO(EBADF, SS_IVCHAN);
1577 * Is it good API design to do flush-all on NULL, a potentially
1578 * errorneous input? Maybe some magical value (PerlIO*
1579 * PERLIO_FLUSH_ALL = (PerlIO*)-1;)? Yes, stdio does similar
1580 * things on fflush(NULL), but should we be bound by their design
1583 PerlIO **table = &PL_perlio;
1585 while ((f = *table)) {
1587 table = (PerlIO **) (f++);
1588 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
1589 if (*f && PerlIO_flush(f) != 0)
1599 PerlIOBase_flush_linebuf(pTHX)
1601 PerlIO **table = &PL_perlio;
1603 while ((f = *table)) {
1605 table = (PerlIO **) (f++);
1606 for (i = 1; i < PERLIO_TABLE_SIZE; i++) {
1609 flags & (PERLIO_F_LINEBUF | PERLIO_F_CANWRITE))
1610 == (PERLIO_F_LINEBUF | PERLIO_F_CANWRITE))
1618 Perl_PerlIO_fill(pTHX_ PerlIO *f)
1621 return (*PerlIOBase(f)->tab->Fill) (aTHX_ f);
1623 SETERRNO(EBADF, SS_IVCHAN);
1629 PerlIO_isutf8(PerlIO *f)
1632 return (PerlIOBase(f)->flags & PERLIO_F_UTF8) != 0;
1634 SETERRNO(EBADF, SS_IVCHAN);
1640 Perl_PerlIO_eof(pTHX_ PerlIO *f)
1643 return (*PerlIOBase(f)->tab->Eof) (aTHX_ f);
1645 SETERRNO(EBADF, SS_IVCHAN);
1651 Perl_PerlIO_error(pTHX_ PerlIO *f)
1654 return (*PerlIOBase(f)->tab->Error) (aTHX_ f);
1656 SETERRNO(EBADF, SS_IVCHAN);
1662 Perl_PerlIO_clearerr(pTHX_ PerlIO *f)
1665 (*PerlIOBase(f)->tab->Clearerr) (aTHX_ f);
1667 SETERRNO(EBADF, SS_IVCHAN);
1671 Perl_PerlIO_setlinebuf(pTHX_ PerlIO *f)
1674 (*PerlIOBase(f)->tab->Setlinebuf) (aTHX_ f);
1676 SETERRNO(EBADF, SS_IVCHAN);
1680 PerlIO_has_base(PerlIO *f)
1682 if (PerlIOValid(f)) {
1683 return (PerlIOBase(f)->tab->Get_base != NULL);
1689 PerlIO_fast_gets(PerlIO *f)
1691 if (PerlIOValid(f) && (PerlIOBase(f)->flags & PERLIO_F_FASTGETS)) {
1692 PerlIO_funcs *tab = PerlIOBase(f)->tab;
1693 return (tab->Set_ptrcnt != NULL);
1699 PerlIO_has_cntptr(PerlIO *f)
1701 if (PerlIOValid(f)) {
1702 PerlIO_funcs *tab = PerlIOBase(f)->tab;
1703 return (tab->Get_ptr != NULL && tab->Get_cnt != NULL);
1709 PerlIO_canset_cnt(PerlIO *f)
1711 if (PerlIOValid(f)) {
1712 PerlIOl *l = PerlIOBase(f);
1713 return (l->tab->Set_ptrcnt != NULL);
1719 Perl_PerlIO_get_base(pTHX_ PerlIO *f)
1722 return (*PerlIOBase(f)->tab->Get_base) (aTHX_ f);
1727 Perl_PerlIO_get_bufsiz(pTHX_ PerlIO *f)
1730 return (*PerlIOBase(f)->tab->Get_bufsiz) (aTHX_ f);
1735 Perl_PerlIO_get_ptr(pTHX_ PerlIO *f)
1737 if (PerlIOValid(f)) {
1738 PerlIO_funcs *tab = PerlIOBase(f)->tab;
1739 if (tab->Get_ptr == NULL)
1741 return (*tab->Get_ptr) (aTHX_ f);
1747 Perl_PerlIO_get_cnt(pTHX_ PerlIO *f)
1749 if (PerlIOValid(f)) {
1750 PerlIO_funcs *tab = PerlIOBase(f)->tab;
1751 if (tab->Get_cnt == NULL)
1753 return (*tab->Get_cnt) (aTHX_ f);
1759 Perl_PerlIO_set_cnt(pTHX_ PerlIO *f, int cnt)
1761 if (PerlIOValid(f)) {
1762 (*PerlIOBase(f)->tab->Set_ptrcnt) (aTHX_ f, NULL, cnt);
1767 Perl_PerlIO_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, int cnt)
1769 if (PerlIOValid(f)) {
1770 PerlIO_funcs *tab = PerlIOBase(f)->tab;
1771 if (tab->Set_ptrcnt == NULL) {
1772 Perl_croak(aTHX_ "PerlIO buffer snooping abuse");
1774 (*PerlIOBase(f)->tab->Set_ptrcnt) (aTHX_ f, ptr, cnt);
1779 /*--------------------------------------------------------------------------------------*/
1781 * utf8 and raw dummy layers
1785 PerlIOUtf8_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1787 if (PerlIOValid(f)) {
1788 if (tab->kind & PERLIO_K_UTF8)
1789 PerlIOBase(f)->flags |= PERLIO_F_UTF8;
1791 PerlIOBase(f)->flags &= ~PERLIO_F_UTF8;
1797 PerlIO_funcs PerlIO_utf8 = {
1798 sizeof(PerlIO_funcs),
1801 PERLIO_K_DUMMY | PERLIO_K_UTF8,
1819 NULL, /* get_base */
1820 NULL, /* get_bufsiz */
1823 NULL, /* set_ptrcnt */
1826 PerlIO_funcs PerlIO_byte = {
1827 sizeof(PerlIO_funcs),
1848 NULL, /* get_base */
1849 NULL, /* get_bufsiz */
1852 NULL, /* set_ptrcnt */
1856 PerlIORaw_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
1857 IV n, const char *mode, int fd, int imode, int perm,
1858 PerlIO *old, int narg, SV **args)
1860 PerlIO_funcs *tab = PerlIO_default_btm();
1861 return (*tab->Open) (aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
1865 PerlIO_funcs PerlIO_raw = {
1866 sizeof(PerlIO_funcs),
1887 NULL, /* get_base */
1888 NULL, /* get_bufsiz */
1891 NULL, /* set_ptrcnt */
1893 /*--------------------------------------------------------------------------------------*/
1894 /*--------------------------------------------------------------------------------------*/
1896 * "Methods" of the "base class"
1900 PerlIOBase_fileno(pTHX_ PerlIO *f)
1902 return PerlIOValid(f) ? PerlIO_fileno(PerlIONext(f)) : -1;
1906 PerlIO_modestr(PerlIO * f, char *buf)
1909 if (PerlIOValid(f)) {
1910 IV flags = PerlIOBase(f)->flags;
1911 if (flags & PERLIO_F_APPEND) {
1913 if (flags & PERLIO_F_CANREAD) {
1917 else if (flags & PERLIO_F_CANREAD) {
1919 if (flags & PERLIO_F_CANWRITE)
1922 else if (flags & PERLIO_F_CANWRITE) {
1924 if (flags & PERLIO_F_CANREAD) {
1928 #ifdef PERLIO_USING_CRLF
1929 if (!(flags & PERLIO_F_CRLF))
1939 PerlIOBase_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
1941 PerlIOl *l = PerlIOBase(f);
1943 const char *omode = mode;
1946 l->flags &= ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE |
1947 PERLIO_F_TRUNCATE | PERLIO_F_APPEND);
1948 if (tab->Set_ptrcnt != NULL)
1949 l->flags |= PERLIO_F_FASTGETS;
1951 if (*mode == '#' || *mode == 'I')
1955 l->flags |= PERLIO_F_CANREAD;
1958 l->flags |= PERLIO_F_APPEND | PERLIO_F_CANWRITE;
1961 l->flags |= PERLIO_F_TRUNCATE | PERLIO_F_CANWRITE;
1964 SETERRNO(EINVAL, LIB_INVARG);
1970 l->flags |= PERLIO_F_CANREAD | PERLIO_F_CANWRITE;
1973 l->flags &= ~PERLIO_F_CRLF;
1976 l->flags |= PERLIO_F_CRLF;
1979 SETERRNO(EINVAL, LIB_INVARG);
1986 l->flags |= l->next->flags &
1987 (PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_TRUNCATE |
1992 PerlIO_debug("PerlIOBase_pushed f=%p %s %s fl=%08" UVxf " (%s)\n",
1993 f, PerlIOBase(f)->tab->name, (omode) ? omode : "(Null)",
1994 l->flags, PerlIO_modestr(f, temp));
2000 PerlIOBase_popped(pTHX_ PerlIO *f)
2006 PerlIOBase_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
2009 * Save the position as current head considers it
2011 Off_t old = PerlIO_tell(f);
2013 PerlIO_push(aTHX_ f, &PerlIO_pending, "r", Nullsv);
2014 PerlIOSelf(f, PerlIOBuf)->posn = old;
2015 done = PerlIOBuf_unread(aTHX_ f, vbuf, count);
2020 PerlIOBase_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
2022 STDCHAR *buf = (STDCHAR *) vbuf;
2024 if (!(PerlIOBase(f)->flags & PERLIO_F_CANREAD))
2027 SSize_t avail = PerlIO_get_cnt(f);
2030 take = ((SSize_t)count < avail) ? count : avail;
2032 STDCHAR *ptr = PerlIO_get_ptr(f);
2033 Copy(ptr, buf, take, STDCHAR);
2034 PerlIO_set_ptrcnt(f, ptr + take, (avail -= take));
2038 if (count > 0 && avail <= 0) {
2039 if (PerlIO_fill(f) != 0)
2043 return (buf - (STDCHAR *) vbuf);
2049 PerlIOBase_noop_ok(pTHX_ PerlIO *f)
2055 PerlIOBase_noop_fail(pTHX_ PerlIO *f)
2061 PerlIOBase_close(pTHX_ PerlIO *f)
2064 PerlIO *n = PerlIONext(f);
2065 if (PerlIO_flush(f) != 0)
2067 if (PerlIOValid(n) && (*PerlIOBase(n)->tab->Close)(aTHX_ n) != 0)
2069 PerlIOBase(f)->flags &=
2070 ~(PERLIO_F_CANREAD | PERLIO_F_CANWRITE | PERLIO_F_OPEN);
2075 PerlIOBase_eof(pTHX_ PerlIO *f)
2077 if (PerlIOValid(f)) {
2078 return (PerlIOBase(f)->flags & PERLIO_F_EOF) != 0;
2084 PerlIOBase_error(pTHX_ PerlIO *f)
2086 if (PerlIOValid(f)) {
2087 return (PerlIOBase(f)->flags & PERLIO_F_ERROR) != 0;
2093 PerlIOBase_clearerr(pTHX_ PerlIO *f)
2095 if (PerlIOValid(f)) {
2096 PerlIO *n = PerlIONext(f);
2097 PerlIOBase(f)->flags &= ~(PERLIO_F_ERROR | PERLIO_F_EOF);
2104 PerlIOBase_setlinebuf(pTHX_ PerlIO *f)
2106 if (PerlIOValid(f)) {
2107 PerlIOBase(f)->flags |= PERLIO_F_LINEBUF;
2112 PerlIO_sv_dup(pTHX_ SV *arg, CLONE_PARAMS *param)
2118 return sv_dup(arg, param);
2121 return newSVsv(arg);
2124 return newSVsv(arg);
2129 PerlIOBase_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2131 PerlIO *nexto = PerlIONext(o);
2132 if (PerlIOValid(nexto)) {
2133 PerlIO_funcs *tab = PerlIOBase(nexto)->tab;
2134 f = (*tab->Dup)(aTHX_ f, nexto, param, flags);
2137 PerlIO_funcs *self = PerlIOBase(o)->tab;
2140 PerlIO_debug("PerlIOBase_dup %s f=%p o=%p param=%p\n",
2141 self->name, (void*)f, (void*)o, (void*)param);
2143 arg = (*self->Getarg)(aTHX_ o,param,flags);
2145 f = PerlIO_push(aTHX_ f, self, PerlIO_modestr(o,buf), arg);
2153 #define PERLIO_MAX_REFCOUNTABLE_FD 2048
2155 perl_mutex PerlIO_mutex;
2157 int PerlIO_fd_refcnt[PERLIO_MAX_REFCOUNTABLE_FD];
2162 /* Place holder for stdstreams call ??? */
2164 MUTEX_INIT(&PerlIO_mutex);
2169 PerlIOUnix_refcnt_inc(int fd)
2171 if (fd >= 0 && fd < PERLIO_MAX_REFCOUNTABLE_FD) {
2173 MUTEX_LOCK(&PerlIO_mutex);
2175 PerlIO_fd_refcnt[fd]++;
2176 PerlIO_debug("fd %d refcnt=%d\n",fd,PerlIO_fd_refcnt[fd]);
2178 MUTEX_UNLOCK(&PerlIO_mutex);
2184 PerlIOUnix_refcnt_dec(int fd)
2187 if (fd >= 0 && fd < PERLIO_MAX_REFCOUNTABLE_FD) {
2189 MUTEX_LOCK(&PerlIO_mutex);
2191 cnt = --PerlIO_fd_refcnt[fd];
2192 PerlIO_debug("fd %d refcnt=%d\n",fd,cnt);
2194 MUTEX_UNLOCK(&PerlIO_mutex);
2201 PerlIO_cleanup(pTHX)
2205 PerlIO_debug("Cleanup layers for %p\n",aTHX);
2207 PerlIO_debug("Cleanup layers\n");
2209 /* Raise STDIN..STDERR refcount so we don't close them */
2210 for (i=0; i < 3; i++)
2211 PerlIOUnix_refcnt_inc(i);
2212 PerlIO_cleantable(aTHX_ &PL_perlio);
2213 /* Restore STDIN..STDERR refcount */
2214 for (i=0; i < 3; i++)
2215 PerlIOUnix_refcnt_dec(i);
2217 if (PL_known_layers) {
2218 PerlIO_list_free(aTHX_ PL_known_layers);
2219 PL_known_layers = NULL;
2221 if(PL_def_layerlist) {
2222 PerlIO_list_free(aTHX_ PL_def_layerlist);
2223 PL_def_layerlist = NULL;
2229 /*--------------------------------------------------------------------------------------*/
2231 * Bottom-most level for UNIX-like case
2235 struct _PerlIO base; /* The generic part */
2236 int fd; /* UNIX like file descriptor */
2237 int oflags; /* open/fcntl flags */
2241 PerlIOUnix_oflags(const char *mode)
2244 if (*mode == 'I' || *mode == '#')
2249 if (*++mode == '+') {
2256 oflags = O_CREAT | O_TRUNC;
2257 if (*++mode == '+') {
2266 oflags = O_CREAT | O_APPEND;
2267 if (*++mode == '+') {
2280 else if (*mode == 't') {
2282 oflags &= ~O_BINARY;
2286 * Always open in binary mode
2289 if (*mode || oflags == -1) {
2290 SETERRNO(EINVAL, LIB_INVARG);
2297 PerlIOUnix_fileno(pTHX_ PerlIO *f)
2299 return PerlIOSelf(f, PerlIOUnix)->fd;
2303 PerlIOUnix_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2305 IV code = PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
2306 PerlIOUnix *s = PerlIOSelf(f, PerlIOUnix);
2307 if (*PerlIONext(f)) {
2308 /* We never call down so do any pending stuff now */
2309 PerlIO_flush(PerlIONext(f));
2310 s->fd = PerlIO_fileno(PerlIONext(f));
2312 * XXX could (or should) we retrieve the oflags from the open file
2313 * handle rather than believing the "mode" we are passed in? XXX
2314 * Should the value on NULL mode be 0 or -1?
2316 s->oflags = mode ? PerlIOUnix_oflags(mode) : -1;
2318 PerlIOBase(f)->flags |= PERLIO_F_OPEN;
2323 PerlIOUnix_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
2324 IV n, const char *mode, int fd, int imode,
2325 int perm, PerlIO *f, int narg, SV **args)
2327 if (PerlIOValid(f)) {
2328 if (PerlIOBase(f)->flags & PERLIO_F_OPEN)
2329 (*PerlIOBase(f)->tab->Close)(aTHX_ f);
2332 char *path = SvPV_nolen(*args);
2336 imode = PerlIOUnix_oflags(mode);
2340 fd = PerlLIO_open3(path, imode, perm);
2348 f = PerlIO_allocate(aTHX);
2350 if (!PerlIOValid(f)) {
2351 if (!(f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg))) {
2355 s = PerlIOSelf(f, PerlIOUnix);
2358 PerlIOBase(f)->flags |= PERLIO_F_OPEN;
2359 PerlIOUnix_refcnt_inc(fd);
2365 * FIXME: pop layers ???
2373 PerlIOUnix_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2375 PerlIOUnix *os = PerlIOSelf(o, PerlIOUnix);
2377 if (flags & PERLIO_DUP_FD) {
2378 fd = PerlLIO_dup(fd);
2380 if (fd >= 0 && fd < PERLIO_MAX_REFCOUNTABLE_FD) {
2381 f = PerlIOBase_dup(aTHX_ f, o, param, flags);
2383 /* If all went well overwrite fd in dup'ed lay with the dup()'ed fd */
2384 PerlIOUnix *s = PerlIOSelf(f, PerlIOUnix);
2386 PerlIOUnix_refcnt_inc(fd);
2395 PerlIOUnix_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
2397 int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2398 if (!(PerlIOBase(f)->flags & PERLIO_F_CANREAD) ||
2399 PerlIOBase(f)->flags & (PERLIO_F_EOF|PERLIO_F_ERROR)) {
2403 SSize_t len = PerlLIO_read(fd, vbuf, count);
2404 if (len >= 0 || errno != EINTR) {
2406 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2407 else if (len == 0 && count != 0)
2408 PerlIOBase(f)->flags |= PERLIO_F_EOF;
2416 PerlIOUnix_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
2418 int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2420 SSize_t len = PerlLIO_write(fd, vbuf, count);
2421 if (len >= 0 || errno != EINTR) {
2423 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
2431 PerlIOUnix_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
2434 PerlLIO_lseek(PerlIOSelf(f, PerlIOUnix)->fd, offset, whence);
2435 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
2436 return (new == (Off_t) - 1) ? -1 : 0;
2440 PerlIOUnix_tell(pTHX_ PerlIO *f)
2442 return PerlLIO_lseek(PerlIOSelf(f, PerlIOUnix)->fd, 0, SEEK_CUR);
2447 PerlIOUnix_close(pTHX_ PerlIO *f)
2449 int fd = PerlIOSelf(f, PerlIOUnix)->fd;
2451 if (PerlIOBase(f)->flags & PERLIO_F_OPEN) {
2452 if (PerlIOUnix_refcnt_dec(fd) > 0) {
2453 PerlIOBase(f)->flags &= ~PERLIO_F_OPEN;
2458 SETERRNO(EBADF,SS_IVCHAN);
2461 while (PerlLIO_close(fd) != 0) {
2462 if (errno != EINTR) {
2469 PerlIOBase(f)->flags &= ~PERLIO_F_OPEN;
2474 PerlIO_funcs PerlIO_unix = {
2475 sizeof(PerlIO_funcs),
2482 PerlIOBase_binmode, /* binmode */
2492 PerlIOBase_noop_ok, /* flush */
2493 PerlIOBase_noop_fail, /* fill */
2496 PerlIOBase_clearerr,
2497 PerlIOBase_setlinebuf,
2498 NULL, /* get_base */
2499 NULL, /* get_bufsiz */
2502 NULL, /* set_ptrcnt */
2505 /*--------------------------------------------------------------------------------------*/
2510 #if defined(VMS) && !defined(STDIO_BUFFER_WRITABLE)
2511 /* perl5.8 - This ensures the last minute VMS ungetc fix is not
2512 broken by the last second glibc 2.3 fix
2514 #define STDIO_BUFFER_WRITABLE
2519 struct _PerlIO base;
2520 FILE *stdio; /* The stream */
2524 PerlIOStdio_fileno(pTHX_ PerlIO *f)
2527 if (PerlIOValid(f) && (s = PerlIOSelf(f, PerlIOStdio)->stdio)) {
2528 return PerlSIO_fileno(s);
2535 PerlIOStdio_mode(const char *mode, char *tmode)
2541 #ifdef PERLIO_USING_CRLF
2549 PerlIOStdio_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
2552 if (PerlIOValid(f) && PerlIOValid(n = PerlIONext(f))) {
2553 PerlIO_funcs *toptab = PerlIOBase(n)->tab;
2554 if (toptab == tab) {
2555 /* Top is already stdio - pop self (duplicate) and use original */
2556 PerlIO_pop(aTHX_ f);
2559 int fd = PerlIO_fileno(n);
2562 if (fd >= 0 && (stdio = PerlSIO_fdopen(fd,
2563 mode = PerlIOStdio_mode(mode, tmode)))) {
2564 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2565 /* We never call down so do any pending stuff now */
2566 PerlIO_flush(PerlIONext(f));
2573 return PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
2578 PerlIO_importFILE(FILE *stdio, const char *mode)
2584 if (!mode || !*mode) {
2585 /* We need to probe to see how we can open the stream
2586 so start with read/write and then try write and read
2587 we dup() so that we can fclose without loosing the fd.
2589 Note that the errno value set by a failing fdopen
2590 varies between stdio implementations.
2592 int fd = PerlLIO_dup(fileno(stdio));
2593 FILE *f2 = PerlSIO_fdopen(fd, (mode = "r+"));
2595 f2 = PerlSIO_fdopen(fd, (mode = "w"));
2598 f2 = PerlSIO_fdopen(fd, (mode = "r"));
2601 /* Don't seem to be able to open */
2607 if ((f = PerlIO_push(aTHX_(f = PerlIO_allocate(aTHX)), &PerlIO_stdio, mode, Nullsv))) {
2608 s = PerlIOSelf(f, PerlIOStdio);
2616 PerlIOStdio_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
2617 IV n, const char *mode, int fd, int imode,
2618 int perm, PerlIO *f, int narg, SV **args)
2621 if (PerlIOValid(f)) {
2622 char *path = SvPV_nolen(*args);
2623 PerlIOStdio *s = PerlIOSelf(f, PerlIOStdio);
2625 PerlIOUnix_refcnt_dec(fileno(s->stdio));
2626 stdio = PerlSIO_freopen(path, (mode = PerlIOStdio_mode(mode, tmode)),
2631 PerlIOUnix_refcnt_inc(fileno(s->stdio));
2636 char *path = SvPV_nolen(*args);
2639 fd = PerlLIO_open3(path, imode, perm);
2642 FILE *stdio = PerlSIO_fopen(path, mode);
2646 f = PerlIO_allocate(aTHX);
2648 if ((f = PerlIO_push(aTHX_ f, self,
2649 (mode = PerlIOStdio_mode(mode, tmode)),
2651 s = PerlIOSelf(f, PerlIOStdio);
2653 PerlIOUnix_refcnt_inc(fileno(s->stdio));
2672 stdio = PerlSIO_stdin;
2675 stdio = PerlSIO_stdout;
2678 stdio = PerlSIO_stderr;
2683 stdio = PerlSIO_fdopen(fd, mode =
2684 PerlIOStdio_mode(mode, tmode));
2689 f = PerlIO_allocate(aTHX);
2691 if ((f = PerlIO_push(aTHX_ f, self, mode, PerlIOArg))) {
2692 s = PerlIOSelf(f, PerlIOStdio);
2694 PerlIOUnix_refcnt_inc(fileno(s->stdio));
2704 PerlIOStdio_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
2706 /* This assumes no layers underneath - which is what
2707 happens, but is not how I remember it. NI-S 2001/10/16
2709 if ((f = PerlIOBase_dup(aTHX_ f, o, param, flags))) {
2710 FILE *stdio = PerlIOSelf(o, PerlIOStdio)->stdio;
2711 int fd = fileno(stdio);
2713 if (flags & PERLIO_DUP_FD) {
2714 int dfd = PerlLIO_dup(fileno(stdio));
2716 stdio = PerlSIO_fdopen(dfd, PerlIO_modestr(o,mode));
2720 /* FIXME: To avoid messy error recovery if dup fails
2721 re-use the existing stdio as though flag was not set
2725 stdio = PerlSIO_fdopen(fd, PerlIO_modestr(o,mode));
2727 PerlIOSelf(f, PerlIOStdio)->stdio = stdio;
2728 PerlIOUnix_refcnt_inc(fileno(stdio));
2734 PerlIOStdio_invalidate_fileno(pTHX_ FILE *f)
2736 /* XXX this could use PerlIO_canset_fileno() and
2737 * PerlIO_set_fileno() support from Configure
2739 # if defined(__GLIBC__)
2740 /* There may be a better way for GLIBC:
2741 - libio.h defines a flag to not close() on cleanup
2745 # elif defined(__sun__)
2747 /* On solaris, if _LP64 is defined, the FILE structure is this:
2753 * It turns out that the fd is stored in the top 32 bits of
2754 * file->__pad[4]. The lower 32 bits contain flags. file->pad[5] appears
2755 * to contain a pointer or offset into another structure. All the
2756 * remaining fields are zero.
2758 * We set the top bits to -1 (0xFFFFFFFF).
2760 f->__pad[4] |= 0xffffffff00000000L;
2761 assert(fileno(f) == 0xffffffff);
2762 # else /* !defined(_LP64) */
2763 /* _file is just a unsigned char :-(
2764 Not clear why we dup() rather than using -1
2765 even if that would be treated as 0xFF - so will
2768 f->_file = PerlLIO_dup(fileno(f));
2769 # endif /* defined(_LP64) */
2771 # elif defined(__hpux)
2775 /* Next one ->_file seems to be a reasonable fallback, i.e. if
2776 your platform does not have special entry try this one.
2777 [For OSF only have confirmation for Tru64 (alpha)
2778 but assume other OSFs will be similar.]
2780 # elif defined(_AIX) || defined(__osf__) || defined(__irix__)
2783 # elif defined(__FreeBSD__)
2784 /* There may be a better way on FreeBSD:
2785 - we could insert a dummy func in the _close function entry
2786 f->_close = (int (*)(void *)) dummy_close;
2790 # elif defined(__CYGWIN__)
2791 /* There may be a better way on CYGWIN:
2792 - we could insert a dummy func in the _close function entry
2793 f->_close = (int (*)(void *)) dummy_close;
2797 # elif defined(WIN32)
2798 # if defined(__BORLANDC__)
2799 f->fd = PerlLIO_dup(fileno(f));
2800 # elif defined(UNDER_CE)
2801 /* WIN_CE does not have access to FILE internals, it hardly has FILE
2810 /* Sarathy's code did this - we fall back to a dup/dup2 hack
2811 (which isn't thread safe) instead
2813 # error "Don't know how to set FILE.fileno on your platform"
2820 PerlIOStdio_close(pTHX_ PerlIO *f)
2822 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
2828 int fd = fileno(stdio);
2834 #ifdef SOCKS5_VERSION_NAME
2835 /* Socks lib overrides close() but stdio isn't linked to
2836 that library (though we are) - so we must call close()
2837 on sockets on stdio's behalf.
2840 Sock_size_t optlen = sizeof(int);
2841 if (getsockopt(fd, SOL_SOCKET, SO_TYPE, (void *) &optval, &optlen) == 0) {
2846 if (PerlIOUnix_refcnt_dec(fd) > 0) {
2847 /* File descriptor still in use */
2852 /* For STD* handles don't close the stdio at all
2853 this is because we have shared the FILE * too
2855 if (stdio == stdin) {
2856 /* Some stdios are buggy fflush-ing inputs */
2859 else if (stdio == stdout || stdio == stderr) {
2860 return PerlIO_flush(f);
2862 /* Tricky - must fclose(stdio) to free memory but not close(fd)
2863 Use Sarathy's trick from maint-5.6 to invalidate the
2864 fileno slot of the FILE *
2866 result = PerlIO_flush(f);
2868 if (!(invalidate = PerlIOStdio_invalidate_fileno(aTHX_ stdio))) {
2869 dupfd = PerlLIO_dup(fd);
2872 result = PerlSIO_fclose(stdio);
2873 /* We treat error from stdio as success if we invalidated
2874 errno may NOT be expected EBADF
2876 if (invalidate && result != 0) {
2881 /* in SOCKS case let close() determine return value */
2885 PerlLIO_dup2(dupfd,fd);
2893 PerlIOStdio_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
2895 FILE *s = PerlIOSelf(f, PerlIOStdio)->stdio;
2899 STDCHAR *buf = (STDCHAR *) vbuf;
2901 * Perl is expecting PerlIO_getc() to fill the buffer Linux's
2902 * stdio does not do that for fread()
2904 int ch = PerlSIO_fgetc(s);
2911 got = PerlSIO_fread(vbuf, 1, count, s);
2912 if (got || errno != EINTR)
2915 errno = 0; /* just in case */
2921 PerlIOStdio_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
2924 FILE *s = PerlIOSelf(f, PerlIOStdio)->stdio;
2926 #ifdef STDIO_BUFFER_WRITABLE
2927 if (PerlIO_fast_gets(f) && PerlIO_has_base(f)) {
2928 STDCHAR *buf = ((STDCHAR *) vbuf) + count;
2929 STDCHAR *base = PerlIO_get_base(f);
2930 SSize_t cnt = PerlIO_get_cnt(f);
2931 STDCHAR *ptr = PerlIO_get_ptr(f);
2932 SSize_t avail = ptr - base;
2934 if (avail > count) {
2938 Move(buf-avail,ptr,avail,STDCHAR);
2941 PerlIO_set_ptrcnt(f,ptr,cnt+avail);
2942 if (PerlSIO_feof(s) && unread >= 0)
2943 PerlSIO_clearerr(s);
2948 if (PerlIO_has_cntptr(f)) {
2949 /* We can get pointer to buffer but not its base
2950 Do ungetc() but check chars are ending up in the
2953 STDCHAR *eptr = (STDCHAR*)PerlSIO_get_ptr(s);
2954 STDCHAR *buf = ((STDCHAR *) vbuf) + count;
2956 int ch = *--buf & 0xFF;
2957 if (ungetc(ch,s) != ch) {
2958 /* ungetc did not work */
2961 if ((STDCHAR*)PerlSIO_get_ptr(s) != --eptr || ((*eptr & 0xFF) != ch)) {
2962 /* Did not change pointer as expected */
2963 fgetc(s); /* get char back again */
2973 unread += PerlIOBase_unread(aTHX_ f, vbuf, count);
2979 PerlIOStdio_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
2983 got = PerlSIO_fwrite(vbuf, 1, count,
2984 PerlIOSelf(f, PerlIOStdio)->stdio);
2985 if (got || errno != EINTR)
2988 errno = 0; /* just in case */
2994 PerlIOStdio_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
2996 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
2997 return PerlSIO_fseek(stdio, offset, whence);
3001 PerlIOStdio_tell(pTHX_ PerlIO *f)
3003 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3004 return PerlSIO_ftell(stdio);
3008 PerlIOStdio_flush(pTHX_ PerlIO *f)
3010 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3011 if (PerlIOBase(f)->flags & PERLIO_F_CANWRITE) {
3012 return PerlSIO_fflush(stdio);
3017 * FIXME: This discards ungetc() and pre-read stuff which is not
3018 * right if this is just a "sync" from a layer above Suspect right
3019 * design is to do _this_ but not have layer above flush this
3020 * layer read-to-read
3023 * Not writeable - sync by attempting a seek
3026 if (PerlSIO_fseek(stdio, (Off_t) 0, SEEK_CUR) != 0)
3034 PerlIOStdio_eof(pTHX_ PerlIO *f)
3036 return PerlSIO_feof(PerlIOSelf(f, PerlIOStdio)->stdio);
3040 PerlIOStdio_error(pTHX_ PerlIO *f)
3042 return PerlSIO_ferror(PerlIOSelf(f, PerlIOStdio)->stdio);
3046 PerlIOStdio_clearerr(pTHX_ PerlIO *f)
3048 PerlSIO_clearerr(PerlIOSelf(f, PerlIOStdio)->stdio);
3052 PerlIOStdio_setlinebuf(pTHX_ PerlIO *f)
3054 #ifdef HAS_SETLINEBUF
3055 PerlSIO_setlinebuf(PerlIOSelf(f, PerlIOStdio)->stdio);
3057 PerlSIO_setvbuf(PerlIOSelf(f, PerlIOStdio)->stdio, Nullch, _IOLBF, 0);
3063 PerlIOStdio_get_base(pTHX_ PerlIO *f)
3065 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3066 return (STDCHAR*)PerlSIO_get_base(stdio);
3070 PerlIOStdio_get_bufsiz(pTHX_ PerlIO *f)
3072 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3073 return PerlSIO_get_bufsiz(stdio);
3077 #ifdef USE_STDIO_PTR
3079 PerlIOStdio_get_ptr(pTHX_ PerlIO *f)
3081 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3082 return (STDCHAR*)PerlSIO_get_ptr(stdio);
3086 PerlIOStdio_get_cnt(pTHX_ PerlIO *f)
3088 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3089 return PerlSIO_get_cnt(stdio);
3093 PerlIOStdio_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
3095 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3097 #ifdef STDIO_PTR_LVALUE
3098 PerlSIO_set_ptr(stdio, (void*)ptr); /* LHS STDCHAR* cast non-portable */
3099 #ifdef STDIO_PTR_LVAL_SETS_CNT
3100 if (PerlSIO_get_cnt(stdio) != (cnt)) {
3101 assert(PerlSIO_get_cnt(stdio) == (cnt));
3104 #if (!defined(STDIO_PTR_LVAL_NOCHANGE_CNT))
3106 * Setting ptr _does_ change cnt - we are done
3110 #else /* STDIO_PTR_LVALUE */
3112 #endif /* STDIO_PTR_LVALUE */
3115 * Now (or only) set cnt
3117 #ifdef STDIO_CNT_LVALUE
3118 PerlSIO_set_cnt(stdio, cnt);
3119 #else /* STDIO_CNT_LVALUE */
3120 #if (defined(STDIO_PTR_LVALUE) && defined(STDIO_PTR_LVAL_SETS_CNT))
3121 PerlSIO_set_ptr(stdio,
3122 PerlSIO_get_ptr(stdio) + (PerlSIO_get_cnt(stdio) -
3124 #else /* STDIO_PTR_LVAL_SETS_CNT */
3126 #endif /* STDIO_PTR_LVAL_SETS_CNT */
3127 #endif /* STDIO_CNT_LVALUE */
3134 PerlIOStdio_fill(pTHX_ PerlIO *f)
3136 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
3139 * fflush()ing read-only streams can cause trouble on some stdio-s
3141 if ((PerlIOBase(f)->flags & PERLIO_F_CANWRITE)) {
3142 if (PerlSIO_fflush(stdio) != 0)
3145 c = PerlSIO_fgetc(stdio);
3149 #if (defined(STDIO_PTR_LVALUE) && (defined(STDIO_CNT_LVALUE) || defined(STDIO_PTR_LVAL_SETS_CNT)))
3151 #ifdef STDIO_BUFFER_WRITABLE
3152 if (PerlIO_fast_gets(f) && PerlIO_has_base(f)) {
3153 /* Fake ungetc() to the real buffer in case system's ungetc
3156 STDCHAR *base = (STDCHAR*)PerlSIO_get_base(stdio);
3157 SSize_t cnt = PerlSIO_get_cnt(stdio);
3158 STDCHAR *ptr = (STDCHAR*)PerlSIO_get_ptr(stdio);
3159 if (ptr == base+1) {
3160 *--ptr = (STDCHAR) c;
3161 PerlIOStdio_set_ptrcnt(aTHX_ f,ptr,cnt+1);
3162 if (PerlSIO_feof(stdio))
3163 PerlSIO_clearerr(stdio);
3169 if (PerlIO_has_cntptr(f)) {
3171 if (PerlIOStdio_unread(aTHX_ f,&ch,1) == 1) {
3178 /* An ungetc()d char is handled separately from the regular
3179 * buffer, so we stuff it in the buffer ourselves.
3180 * Should never get called as should hit code above
3182 *(--((*stdio)->_ptr)) = (unsigned char) c;
3185 /* If buffer snoop scheme above fails fall back to
3188 if (PerlSIO_ungetc(c, stdio) != c)
3196 PerlIO_funcs PerlIO_stdio = {
3197 sizeof(PerlIO_funcs),
3199 sizeof(PerlIOStdio),
3200 PERLIO_K_BUFFERED|PERLIO_K_RAW,
3204 PerlIOBase_binmode, /* binmode */
3218 PerlIOStdio_clearerr,
3219 PerlIOStdio_setlinebuf,
3221 PerlIOStdio_get_base,
3222 PerlIOStdio_get_bufsiz,
3227 #ifdef USE_STDIO_PTR
3228 PerlIOStdio_get_ptr,
3229 PerlIOStdio_get_cnt,
3230 # if defined(HAS_FAST_STDIO) && defined(USE_FAST_STDIO)
3231 PerlIOStdio_set_ptrcnt,
3234 # endif /* HAS_FAST_STDIO && USE_FAST_STDIO */
3239 #endif /* USE_STDIO_PTR */
3242 /* Note that calls to PerlIO_exportFILE() are reversed using
3243 * PerlIO_releaseFILE(), not importFILE. */
3245 PerlIO_exportFILE(PerlIO * f, const char *mode)
3249 if (PerlIOValid(f)) {
3252 if (!mode || !*mode) {
3253 mode = PerlIO_modestr(f, buf);
3255 stdio = PerlSIO_fdopen(PerlIO_fileno(f), mode);
3258 /* De-link any lower layers so new :stdio sticks */
3260 if ((f = PerlIO_push(aTHX_ f, &PerlIO_stdio, buf, Nullsv))) {
3261 PerlIOStdio *s = PerlIOSelf(f, PerlIOStdio);
3263 /* Link previous lower layers under new one */
3267 /* restore layers list */
3277 PerlIO_findFILE(PerlIO *f)
3281 if (l->tab == &PerlIO_stdio) {
3282 PerlIOStdio *s = PerlIOSelf(&l, PerlIOStdio);
3285 l = *PerlIONext(&l);
3287 /* Uses fallback "mode" via PerlIO_modestr() in PerlIO_exportFILE */
3288 return PerlIO_exportFILE(f, Nullch);
3291 /* Use this to reverse PerlIO_exportFILE calls. */
3293 PerlIO_releaseFILE(PerlIO *p, FILE *f)
3297 if (l->tab == &PerlIO_stdio) {
3298 PerlIOStdio *s = PerlIOSelf(&l, PerlIOStdio);
3299 if (s->stdio == f) {
3301 PerlIO_pop(aTHX_ p);
3310 /*--------------------------------------------------------------------------------------*/
3312 * perlio buffer layer
3316 PerlIOBuf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
3318 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3319 int fd = PerlIO_fileno(f);
3320 if (fd >= 0 && PerlLIO_isatty(fd)) {
3321 PerlIOBase(f)->flags |= PERLIO_F_LINEBUF | PERLIO_F_TTY;
3323 if (*PerlIONext(f)) {
3324 Off_t posn = PerlIO_tell(PerlIONext(f));
3325 if (posn != (Off_t) - 1) {
3329 return PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
3333 PerlIOBuf_open(pTHX_ PerlIO_funcs *self, PerlIO_list_t *layers,
3334 IV n, const char *mode, int fd, int imode, int perm,
3335 PerlIO *f, int narg, SV **args)
3337 if (PerlIOValid(f)) {
3338 PerlIO *next = PerlIONext(f);
3339 PerlIO_funcs *tab = PerlIO_layer_fetch(aTHX_ layers, n - 1, PerlIOBase(next)->tab);
3340 next = (*tab->Open) (aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
3342 if (!next || (*PerlIOBase(f)->tab->Pushed) (aTHX_ f, mode, PerlIOArg, self) != 0) {
3347 PerlIO_funcs *tab = PerlIO_layer_fetch(aTHX_ layers, n - 1, PerlIO_default_btm());
3355 f = (*tab->Open) (aTHX_ tab, layers, n - 1, mode, fd, imode, perm,
3358 if (PerlIO_push(aTHX_ f, self, mode, PerlIOArg) == 0) {
3360 * if push fails during open, open fails. close will pop us.
3365 fd = PerlIO_fileno(f);
3366 if (init && fd == 2) {
3368 * Initial stderr is unbuffered
3370 PerlIOBase(f)->flags |= PERLIO_F_UNBUF;
3372 #ifdef PERLIO_USING_CRLF
3373 # ifdef PERLIO_IS_BINMODE_FD
3374 if (PERLIO_IS_BINMODE_FD(fd))
3375 PerlIO_binmode(aTHX_ f, '<'/*not used*/, O_BINARY, Nullch);
3379 * do something about failing setmode()? --jhi
3381 PerlLIO_setmode(fd, O_BINARY);
3390 * This "flush" is akin to sfio's sync in that it handles files in either
3391 * read or write state
3394 PerlIOBuf_flush(pTHX_ PerlIO *f)
3396 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3398 PerlIO *n = PerlIONext(f);
3399 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF) {
3401 * write() the buffer
3403 STDCHAR *buf = b->buf;
3405 while (p < b->ptr) {
3406 SSize_t count = PerlIO_write(n, p, b->ptr - p);
3410 else if (count < 0 || PerlIO_error(n)) {
3411 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
3416 b->posn += (p - buf);
3418 else if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3419 STDCHAR *buf = PerlIO_get_base(f);
3421 * Note position change
3423 b->posn += (b->ptr - buf);
3424 if (b->ptr < b->end) {
3425 /* We did not consume all of it - try and seek downstream to
3426 our logical position
3428 if (PerlIOValid(n) && PerlIO_seek(n, b->posn, SEEK_SET) == 0) {
3429 /* Reload n as some layers may pop themselves on seek */
3430 b->posn = PerlIO_tell(n = PerlIONext(f));
3433 /* Seek failed (e.g. pipe or tty). Do NOT clear buffer or pre-read
3434 data is lost for good - so return saying "ok" having undone
3437 b->posn -= (b->ptr - buf);
3442 b->ptr = b->end = b->buf;
3443 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3444 /* We check for Valid because of dubious decision to make PerlIO_flush(NULL) flush all */
3445 if (PerlIOValid(n) && PerlIO_flush(n) != 0)
3451 PerlIOBuf_fill(pTHX_ PerlIO *f)
3453 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3454 PerlIO *n = PerlIONext(f);
3457 * Down-stream flush is defined not to loose read data so is harmless.
3458 * we would not normally be fill'ing if there was data left in anycase.
3460 if (PerlIO_flush(f) != 0)
3462 if (PerlIOBase(f)->flags & PERLIO_F_TTY)
3463 PerlIOBase_flush_linebuf(aTHX);
3466 PerlIO_get_base(f); /* allocate via vtable */
3468 b->ptr = b->end = b->buf;
3470 if (!PerlIOValid(n)) {
3471 PerlIOBase(f)->flags |= PERLIO_F_EOF;
3475 if (PerlIO_fast_gets(n)) {
3477 * Layer below is also buffered. We do _NOT_ want to call its
3478 * ->Read() because that will loop till it gets what we asked for
3479 * which may hang on a pipe etc. Instead take anything it has to
3480 * hand, or ask it to fill _once_.
3482 avail = PerlIO_get_cnt(n);
3484 avail = PerlIO_fill(n);
3486 avail = PerlIO_get_cnt(n);
3488 if (!PerlIO_error(n) && PerlIO_eof(n))
3493 STDCHAR *ptr = PerlIO_get_ptr(n);
3494 SSize_t cnt = avail;
3495 if (avail > (SSize_t)b->bufsiz)
3497 Copy(ptr, b->buf, avail, STDCHAR);
3498 PerlIO_set_ptrcnt(n, ptr + avail, cnt - avail);
3502 avail = PerlIO_read(n, b->ptr, b->bufsiz);
3506 PerlIOBase(f)->flags |= PERLIO_F_EOF;
3508 PerlIOBase(f)->flags |= PERLIO_F_ERROR;
3511 b->end = b->buf + avail;
3512 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3517 PerlIOBuf_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
3519 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3520 if (PerlIOValid(f)) {
3523 return PerlIOBase_read(aTHX_ f, vbuf, count);
3529 PerlIOBuf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3531 const STDCHAR *buf = (const STDCHAR *) vbuf + count;
3532 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3535 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
3540 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3542 * Buffer is already a read buffer, we can overwrite any chars
3543 * which have been read back to buffer start
3545 avail = (b->ptr - b->buf);
3549 * Buffer is idle, set it up so whole buffer is available for
3553 b->end = b->buf + avail;
3555 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3557 * Buffer extends _back_ from where we are now
3559 b->posn -= b->bufsiz;
3561 if (avail > (SSize_t) count) {
3563 * If we have space for more than count, just move count
3571 * In simple stdio-like ungetc() case chars will be already
3574 if (buf != b->ptr) {
3575 Copy(buf, b->ptr, avail, STDCHAR);
3579 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
3583 unread += PerlIOBase_unread(aTHX_ f, vbuf, count);
3589 PerlIOBuf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3591 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3592 const STDCHAR *buf = (const STDCHAR *) vbuf;
3596 if (!(PerlIOBase(f)->flags & PERLIO_F_CANWRITE))
3598 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
3599 if (PerlIO_flush(f) != 0) {
3604 SSize_t avail = b->bufsiz - (b->ptr - b->buf);
3605 if ((SSize_t) count < avail)
3607 PerlIOBase(f)->flags |= PERLIO_F_WRBUF;
3608 if (PerlIOBase(f)->flags & PERLIO_F_LINEBUF) {
3623 Copy(buf, b->ptr, avail, STDCHAR);
3630 if (b->ptr >= (b->buf + b->bufsiz))
3633 if (PerlIOBase(f)->flags & PERLIO_F_UNBUF)
3639 PerlIOBuf_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3642 if ((code = PerlIO_flush(f)) == 0) {
3643 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3644 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
3645 code = PerlIO_seek(PerlIONext(f), offset, whence);
3647 b->posn = PerlIO_tell(PerlIONext(f));
3654 PerlIOBuf_tell(pTHX_ PerlIO *f)
3656 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3658 * b->posn is file position where b->buf was read, or will be written
3660 Off_t posn = b->posn;
3661 if ((PerlIOBase(f)->flags & PERLIO_F_APPEND) &&
3662 (PerlIOBase(f)->flags & PERLIO_F_WRBUF)) {
3664 /* As O_APPEND files are normally shared in some sense it is better
3669 /* when file is NOT shared then this is sufficient */
3670 PerlIO_seek(PerlIONext(f),0, SEEK_END);
3672 posn = b->posn = PerlIO_tell(PerlIONext(f));
3676 * If buffer is valid adjust position by amount in buffer
3678 posn += (b->ptr - b->buf);
3684 PerlIOBuf_popped(pTHX_ PerlIO *f)
3686 IV code = PerlIOBase_popped(aTHX_ f);
3687 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3688 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
3692 b->ptr = b->end = b->buf;
3693 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3698 PerlIOBuf_close(pTHX_ PerlIO *f)
3700 IV code = PerlIOBase_close(aTHX_ f);
3701 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3702 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
3706 b->ptr = b->end = b->buf;
3707 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
3712 PerlIOBuf_get_ptr(pTHX_ PerlIO *f)
3714 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3721 PerlIOBuf_get_cnt(pTHX_ PerlIO *f)
3723 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3726 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF)
3727 return (b->end - b->ptr);
3732 PerlIOBuf_get_base(pTHX_ PerlIO *f)
3734 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3739 Newz('B',b->buf,b->bufsiz, STDCHAR);
3741 b->buf = (STDCHAR *) & b->oneword;
3742 b->bufsiz = sizeof(b->oneword);
3751 PerlIOBuf_bufsiz(pTHX_ PerlIO *f)
3753 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3756 return (b->end - b->buf);
3760 PerlIOBuf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
3762 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3766 if (PerlIO_get_cnt(f) != cnt || b->ptr < b->buf) {
3767 assert(PerlIO_get_cnt(f) == cnt);
3768 assert(b->ptr >= b->buf);
3770 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3774 PerlIOBuf_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
3776 return PerlIOBase_dup(aTHX_ f, o, param, flags);
3781 PerlIO_funcs PerlIO_perlio = {
3782 sizeof(PerlIO_funcs),
3785 PERLIO_K_BUFFERED|PERLIO_K_RAW,
3789 PerlIOBase_binmode, /* binmode */
3803 PerlIOBase_clearerr,
3804 PerlIOBase_setlinebuf,
3809 PerlIOBuf_set_ptrcnt,
3812 /*--------------------------------------------------------------------------------------*/
3814 * Temp layer to hold unread chars when cannot do it any other way
3818 PerlIOPending_fill(pTHX_ PerlIO *f)
3821 * Should never happen
3828 PerlIOPending_close(pTHX_ PerlIO *f)
3831 * A tad tricky - flush pops us, then we close new top
3834 return PerlIO_close(f);
3838 PerlIOPending_seek(pTHX_ PerlIO *f, Off_t offset, int whence)
3841 * A tad tricky - flush pops us, then we seek new top
3844 return PerlIO_seek(f, offset, whence);
3849 PerlIOPending_flush(pTHX_ PerlIO *f)
3851 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3852 if (b->buf && b->buf != (STDCHAR *) & b->oneword) {
3856 PerlIO_pop(aTHX_ f);
3861 PerlIOPending_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
3867 PerlIOBuf_set_ptrcnt(aTHX_ f, ptr, cnt);
3872 PerlIOPending_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
3874 IV code = PerlIOBase_pushed(aTHX_ f, mode, arg, tab);
3875 PerlIOl *l = PerlIOBase(f);
3877 * Our PerlIO_fast_gets must match what we are pushed on, or sv_gets()
3878 * etc. get muddled when it changes mid-string when we auto-pop.
3880 l->flags = (l->flags & ~(PERLIO_F_FASTGETS | PERLIO_F_UTF8)) |
3881 (PerlIOBase(PerlIONext(f))->
3882 flags & (PERLIO_F_FASTGETS | PERLIO_F_UTF8));
3887 PerlIOPending_read(pTHX_ PerlIO *f, void *vbuf, Size_t count)
3889 SSize_t avail = PerlIO_get_cnt(f);
3891 if ((SSize_t)count < avail)
3894 got = PerlIOBuf_read(aTHX_ f, vbuf, avail);
3895 if (got >= 0 && got < (SSize_t)count) {
3897 PerlIO_read(f, ((STDCHAR *) vbuf) + got, count - got);
3898 if (more >= 0 || got == 0)
3904 PerlIO_funcs PerlIO_pending = {
3905 sizeof(PerlIO_funcs),
3908 PERLIO_K_BUFFERED|PERLIO_K_RAW, /* not sure about RAW here */
3909 PerlIOPending_pushed,
3912 PerlIOBase_binmode, /* binmode */
3921 PerlIOPending_close,
3922 PerlIOPending_flush,
3926 PerlIOBase_clearerr,
3927 PerlIOBase_setlinebuf,
3932 PerlIOPending_set_ptrcnt,
3937 /*--------------------------------------------------------------------------------------*/
3939 * crlf - translation On read translate CR,LF to "\n" we do this by
3940 * overriding ptr/cnt entries to hand back a line at a time and keeping a
3941 * record of which nl we "lied" about. On write translate "\n" to CR,LF
3945 PerlIOBuf base; /* PerlIOBuf stuff */
3946 STDCHAR *nl; /* Position of crlf we "lied" about in the
3951 PerlIOCrlf_pushed(pTHX_ PerlIO *f, const char *mode, SV *arg, PerlIO_funcs *tab)
3954 PerlIOBase(f)->flags |= PERLIO_F_CRLF;
3955 code = PerlIOBuf_pushed(aTHX_ f, mode, arg, tab);
3957 PerlIO_debug("PerlIOCrlf_pushed f=%p %s %s fl=%08" UVxf "\n",
3958 f, PerlIOBase(f)->tab->name, (mode) ? mode : "(Null)",
3959 PerlIOBase(f)->flags);
3966 PerlIOCrlf_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
3968 PerlIOCrlf *c = PerlIOSelf(f, PerlIOCrlf);
3973 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF))
3974 return PerlIOBuf_unread(aTHX_ f, vbuf, count);
3976 const STDCHAR *buf = (const STDCHAR *) vbuf + count;
3977 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
3979 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
3984 if (!(PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
3985 b->end = b->ptr = b->buf + b->bufsiz;
3986 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
3987 b->posn -= b->bufsiz;
3989 while (count > 0 && b->ptr > b->buf) {
3992 if (b->ptr - 2 >= b->buf) {
4015 PerlIOCrlf_get_cnt(pTHX_ PerlIO *f)
4017 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4020 if (PerlIOBase(f)->flags & PERLIO_F_RDBUF) {
4021 PerlIOCrlf *c = PerlIOSelf(f, PerlIOCrlf);
4022 if ((PerlIOBase(f)->flags & PERLIO_F_CRLF) && (!c->nl || *c->nl == 0xd)) {
4023 STDCHAR *nl = (c->nl) ? c->nl : b->ptr;
4025 while (nl < b->end && *nl != 0xd)
4027 if (nl < b->end && *nl == 0xd) {
4029 if (nl + 1 < b->end) {
4036 * Not CR,LF but just CR
4044 * Blast - found CR as last char in buffer
4049 * They may not care, defer work as long as
4053 return (nl - b->ptr);
4057 b->ptr++; /* say we have read it as far as
4058 * flush() is concerned */
4059 b->buf++; /* Leave space in front of buffer */
4060 /* Note as we have moved buf up flush's
4062 will naturally make posn point at CR
4064 b->bufsiz--; /* Buffer is thus smaller */
4065 code = PerlIO_fill(f); /* Fetch some more */
4066 b->bufsiz++; /* Restore size for next time */
4067 b->buf--; /* Point at space */
4068 b->ptr = nl = b->buf; /* Which is what we hand
4070 *nl = 0xd; /* Fill in the CR */
4072 goto test; /* fill() call worked */
4074 * CR at EOF - just fall through
4076 /* Should we clear EOF though ??? */
4081 return (((c->nl) ? (c->nl + 1) : b->end) - b->ptr);
4087 PerlIOCrlf_set_ptrcnt(pTHX_ PerlIO *f, STDCHAR * ptr, SSize_t cnt)
4089 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4090 PerlIOCrlf *c = PerlIOSelf(f, PerlIOCrlf);
4096 if (ptr == b->end && *c->nl == 0xd) {
4097 /* Defered CR at end of buffer case - we lied about count */
4109 * Test code - delete when it works ...
4111 IV flags = PerlIOBase(f)->flags;
4112 STDCHAR *chk = (c->nl) ? (c->nl+1) : b->end;
4113 if (ptr+cnt == c->nl && c->nl+1 == b->end && *c->nl == 0xd) {
4114 /* Defered CR at end of buffer case - we lied about count */
4120 Perl_croak(aTHX_ "ptr wrong %p != %p fl=%08" UVxf
4121 " nl=%p e=%p for %d", ptr, chk, flags, c->nl,
4129 * They have taken what we lied about
4137 PerlIOBase(f)->flags |= PERLIO_F_RDBUF;
4141 PerlIOCrlf_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4143 if (!(PerlIOBase(f)->flags & PERLIO_F_CRLF))
4144 return PerlIOBuf_write(aTHX_ f, vbuf, count);
4146 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4147 const STDCHAR *buf = (const STDCHAR *) vbuf;
4148 const STDCHAR *ebuf = buf + count;
4151 if (!(PerlIOBase(f)->flags & PERLIO_F_CANWRITE))
4153 while (buf < ebuf) {
4154 STDCHAR *eptr = b->buf + b->bufsiz;
4155 PerlIOBase(f)->flags |= PERLIO_F_WRBUF;
4156 while (buf < ebuf && b->ptr < eptr) {
4158 if ((b->ptr + 2) > eptr) {
4166 *(b->ptr)++ = 0xd; /* CR */
4167 *(b->ptr)++ = 0xa; /* LF */
4169 if (PerlIOBase(f)->flags & PERLIO_F_LINEBUF) {
4179 if (b->ptr >= eptr) {
4185 if (PerlIOBase(f)->flags & PERLIO_F_UNBUF)
4187 return (buf - (STDCHAR *) vbuf);
4192 PerlIOCrlf_flush(pTHX_ PerlIO *f)
4194 PerlIOCrlf *c = PerlIOSelf(f, PerlIOCrlf);
4199 return PerlIOBuf_flush(aTHX_ f);
4203 PerlIOCrlf_binmode(pTHX_ PerlIO *f)
4205 if ((PerlIOBase(f)->flags & PERLIO_F_CRLF)) {
4206 /* In text mode - flush any pending stuff and flip it */
4207 PerlIOBase(f)->flags &= ~PERLIO_F_CRLF;
4208 #ifndef PERLIO_USING_CRLF
4209 /* CRLF is unusual case - if this is just the :crlf layer pop it */
4210 if (PerlIOBase(f)->tab == &PerlIO_crlf) {
4211 PerlIO_pop(aTHX_ f);
4218 PerlIO_funcs PerlIO_crlf = {
4219 sizeof(PerlIO_funcs),
4222 PERLIO_K_BUFFERED | PERLIO_K_CANCRLF | PERLIO_K_RAW,
4224 PerlIOBuf_popped, /* popped */
4226 PerlIOCrlf_binmode, /* binmode */
4230 PerlIOBuf_read, /* generic read works with ptr/cnt lies
4232 PerlIOCrlf_unread, /* Put CR,LF in buffer for each '\n' */
4233 PerlIOCrlf_write, /* Put CR,LF in buffer for each '\n' */
4241 PerlIOBase_clearerr,
4242 PerlIOBase_setlinebuf,
4247 PerlIOCrlf_set_ptrcnt,
4251 /*--------------------------------------------------------------------------------------*/
4253 * mmap as "buffer" layer
4257 PerlIOBuf base; /* PerlIOBuf stuff */
4258 Mmap_t mptr; /* Mapped address */
4259 Size_t len; /* mapped length */
4260 STDCHAR *bbuf; /* malloced buffer if map fails */
4263 static size_t page_size = 0;
4266 PerlIOMmap_map(pTHX_ PerlIO *f)
4268 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4269 IV flags = PerlIOBase(f)->flags;
4273 if (flags & PERLIO_F_CANREAD) {
4274 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4275 int fd = PerlIO_fileno(f);
4277 code = Fstat(fd, &st);
4278 if (code == 0 && S_ISREG(st.st_mode)) {
4279 SSize_t len = st.st_size - b->posn;
4283 #if defined(HAS_SYSCONF) && (defined(_SC_PAGESIZE) || defined(_SC_PAGE_SIZE))
4285 SETERRNO(0, SS_NORMAL);
4286 # ifdef _SC_PAGESIZE
4287 page_size = sysconf(_SC_PAGESIZE);
4289 page_size = sysconf(_SC_PAGE_SIZE);
4291 if ((long) page_size < 0) {
4296 (void) SvUPGRADE(error, SVt_PV);
4297 msg = SvPVx(error, n_a);
4298 Perl_croak(aTHX_ "panic: sysconf: %s",
4303 "panic: sysconf: pagesize unknown");
4307 # ifdef HAS_GETPAGESIZE
4308 page_size = getpagesize();
4310 # if defined(I_SYS_PARAM) && defined(PAGESIZE)
4311 page_size = PAGESIZE; /* compiletime, bad */
4315 if ((IV) page_size <= 0)
4316 Perl_croak(aTHX_ "panic: bad pagesize %" IVdf,
4321 * This is a hack - should never happen - open should
4324 b->posn = PerlIO_tell(PerlIONext(f));
4326 posn = (b->posn / page_size) * page_size;
4327 len = st.st_size - posn;
4328 m->mptr = mmap(NULL, len, PROT_READ, MAP_SHARED, fd, posn);
4329 if (m->mptr && m->mptr != (Mmap_t) - 1) {
4330 #if 0 && defined(HAS_MADVISE) && defined(MADV_SEQUENTIAL)
4331 madvise(m->mptr, len, MADV_SEQUENTIAL);
4333 #if 0 && defined(HAS_MADVISE) && defined(MADV_WILLNEED)
4334 madvise(m->mptr, len, MADV_WILLNEED);
4336 PerlIOBase(f)->flags =
4337 (flags & ~PERLIO_F_EOF) | PERLIO_F_RDBUF;
4338 b->end = ((STDCHAR *) m->mptr) + len;
4339 b->buf = ((STDCHAR *) m->mptr) + (b->posn - posn);
4348 PerlIOBase(f)->flags =
4349 flags | PERLIO_F_EOF | PERLIO_F_RDBUF;
4351 b->ptr = b->end = b->ptr;
4360 PerlIOMmap_unmap(pTHX_ PerlIO *f)
4362 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4363 PerlIOBuf *b = &m->base;
4367 code = munmap(m->mptr, m->len);
4371 if (PerlIO_seek(PerlIONext(f), b->posn, SEEK_SET) != 0)
4374 b->ptr = b->end = b->buf;
4375 PerlIOBase(f)->flags &= ~(PERLIO_F_RDBUF | PERLIO_F_WRBUF);
4381 PerlIOMmap_get_base(pTHX_ PerlIO *f)
4383 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4384 PerlIOBuf *b = &m->base;
4385 if (b->buf && (PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4387 * Already have a readbuffer in progress
4393 * We have a write buffer or flushed PerlIOBuf read buffer
4395 m->bbuf = b->buf; /* save it in case we need it again */
4396 b->buf = NULL; /* Clear to trigger below */
4399 PerlIOMmap_map(aTHX_ f); /* Try and map it */
4402 * Map did not work - recover PerlIOBuf buffer if we have one
4407 b->ptr = b->end = b->buf;
4410 return PerlIOBuf_get_base(aTHX_ f);
4414 PerlIOMmap_unread(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4416 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4417 PerlIOBuf *b = &m->base;
4418 if (PerlIOBase(f)->flags & PERLIO_F_WRBUF)
4420 if (b->ptr && (b->ptr - count) >= b->buf
4421 && memEQ(b->ptr - count, vbuf, count)) {
4423 PerlIOBase(f)->flags &= ~PERLIO_F_EOF;
4428 * Loose the unwritable mapped buffer
4432 * If flush took the "buffer" see if we have one from before
4434 if (!b->buf && m->bbuf)
4437 PerlIOBuf_get_base(aTHX_ f);
4441 return PerlIOBuf_unread(aTHX_ f, vbuf, count);
4445 PerlIOMmap_write(pTHX_ PerlIO *f, const void *vbuf, Size_t count)
4447 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4448 PerlIOBuf *b = &m->base;
4449 if (!b->buf || !(PerlIOBase(f)->flags & PERLIO_F_WRBUF)) {
4451 * No, or wrong sort of, buffer
4454 if (PerlIOMmap_unmap(aTHX_ f) != 0)
4458 * If unmap took the "buffer" see if we have one from before
4460 if (!b->buf && m->bbuf)
4463 PerlIOBuf_get_base(aTHX_ f);
4467 return PerlIOBuf_write(aTHX_ f, vbuf, count);
4471 PerlIOMmap_flush(pTHX_ PerlIO *f)
4473 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4474 PerlIOBuf *b = &m->base;
4475 IV code = PerlIOBuf_flush(aTHX_ f);
4477 * Now we are "synced" at PerlIOBuf level
4484 if (PerlIOMmap_unmap(aTHX_ f) != 0)
4489 * We seem to have a PerlIOBuf buffer which was not mapped
4490 * remember it in case we need one later
4499 PerlIOMmap_fill(pTHX_ PerlIO *f)
4501 PerlIOBuf *b = PerlIOSelf(f, PerlIOBuf);
4502 IV code = PerlIO_flush(f);
4503 if (code == 0 && !b->buf) {
4504 code = PerlIOMmap_map(aTHX_ f);
4506 if (code == 0 && !(PerlIOBase(f)->flags & PERLIO_F_RDBUF)) {
4507 code = PerlIOBuf_fill(aTHX_ f);
4513 PerlIOMmap_close(pTHX_ PerlIO *f)
4515 PerlIOMmap *m = PerlIOSelf(f, PerlIOMmap);
4516 PerlIOBuf *b = &m->base;
4517 IV code = PerlIO_flush(f);
4521 b->ptr = b->end = b->buf;
4523 if (PerlIOBuf_close(aTHX_ f) != 0)
4529 PerlIOMmap_dup(pTHX_ PerlIO *f, PerlIO *o, CLONE_PARAMS *param, int flags)
4531 return PerlIOBase_dup(aTHX_ f, o, param, flags);
4535 PerlIO_funcs PerlIO_mmap = {
4536 sizeof(PerlIO_funcs),
4539 PERLIO_K_BUFFERED|PERLIO_K_RAW,
4543 PerlIOBase_binmode, /* binmode */
4557 PerlIOBase_clearerr,
4558 PerlIOBase_setlinebuf,
4559 PerlIOMmap_get_base,
4563 PerlIOBuf_set_ptrcnt,
4566 #endif /* HAS_MMAP */
4569 Perl_PerlIO_stdin(pTHX)
4572 PerlIO_stdstreams(aTHX);
4574 return &PL_perlio[1];
4578 Perl_PerlIO_stdout(pTHX)
4581 PerlIO_stdstreams(aTHX);
4583 return &PL_perlio[2];
4587 Perl_PerlIO_stderr(pTHX)
4590 PerlIO_stdstreams(aTHX);
4592 return &PL_perlio[3];
4595 /*--------------------------------------------------------------------------------------*/
4598 PerlIO_getname(PerlIO *f, char *buf)
4603 FILE *stdio = PerlIOSelf(f, PerlIOStdio)->stdio;
4605 name = fgetname(stdio, buf);
4607 Perl_croak(aTHX_ "Don't know how to get file name");
4613 /*--------------------------------------------------------------------------------------*/
4615 * Functions which can be called on any kind of PerlIO implemented in
4619 #undef PerlIO_fdopen
4621 PerlIO_fdopen(int fd, const char *mode)
4624 return PerlIO_openn(aTHX_ Nullch, mode, fd, 0, 0, NULL, 0, NULL);
4629 PerlIO_open(const char *path, const char *mode)
4632 SV *name = sv_2mortal(newSVpvn(path, strlen(path)));
4633 return PerlIO_openn(aTHX_ Nullch, mode, -1, 0, 0, NULL, 1, &name);
4636 #undef Perlio_reopen
4638 PerlIO_reopen(const char *path, const char *mode, PerlIO *f)
4641 SV *name = sv_2mortal(newSVpvn(path, strlen(path)));
4642 return PerlIO_openn(aTHX_ Nullch, mode, -1, 0, 0, f, 1, &name);
4647 PerlIO_getc(PerlIO *f)
4651 SSize_t count = PerlIO_read(f, buf, 1);
4653 return (unsigned char) buf[0];
4658 #undef PerlIO_ungetc
4660 PerlIO_ungetc(PerlIO *f, int ch)
4665 if (PerlIO_unread(f, &buf, 1) == 1)
4673 PerlIO_putc(PerlIO *f, int ch)
4677 return PerlIO_write(f, &buf, 1);
4682 PerlIO_puts(PerlIO *f, const char *s)
4685 STRLEN len = strlen(s);
4686 return PerlIO_write(f, s, len);
4689 #undef PerlIO_rewind
4691 PerlIO_rewind(PerlIO *f)
4694 PerlIO_seek(f, (Off_t) 0, SEEK_SET);
4698 #undef PerlIO_vprintf
4700 PerlIO_vprintf(PerlIO *f, const char *fmt, va_list ap)
4703 SV *sv = newSVpvn("", 0);
4709 Perl_va_copy(ap, apc);
4710 sv_vcatpvf(sv, fmt, &apc);
4712 sv_vcatpvf(sv, fmt, &ap);
4715 wrote = PerlIO_write(f, s, len);
4720 #undef PerlIO_printf
4722 PerlIO_printf(PerlIO *f, const char *fmt, ...)
4727 result = PerlIO_vprintf(f, fmt, ap);
4732 #undef PerlIO_stdoutf
4734 PerlIO_stdoutf(const char *fmt, ...)
4740 result = PerlIO_vprintf(PerlIO_stdout(), fmt, ap);
4745 #undef PerlIO_tmpfile
4747 PerlIO_tmpfile(void)
4750 * I have no idea how portable mkstemp() is ...
4752 #if defined(WIN32) || !defined(HAVE_MKSTEMP)
4755 FILE *stdio = PerlSIO_tmpfile();
4757 if ((f = PerlIO_push(aTHX_(PerlIO_allocate(aTHX)), &PerlIO_stdio, "w+", Nullsv))) {
4758 PerlIOStdio *s = PerlIOSelf(f, PerlIOStdio);
4765 SV *sv = newSVpv("/tmp/PerlIO_XXXXXX", 0);
4766 int fd = mkstemp(SvPVX(sv));
4769 f = PerlIO_fdopen(fd, "w+");
4771 PerlIOBase(f)->flags |= PERLIO_F_TEMP;
4773 PerlLIO_unlink(SvPVX(sv));
4783 #endif /* USE_SFIO */
4784 #endif /* PERLIO_IS_STDIO */
4786 /*======================================================================================*/
4788 * Now some functions in terms of above which may be needed even if we are
4789 * not in true PerlIO mode
4793 #undef PerlIO_setpos
4795 PerlIO_setpos(PerlIO *f, SV *pos)
4800 Off_t *posn = (Off_t *) SvPV(pos, len);
4801 if (f && len == sizeof(Off_t))
4802 return PerlIO_seek(f, *posn, SEEK_SET);
4804 SETERRNO(EINVAL, SS_IVCHAN);
4808 #undef PerlIO_setpos
4810 PerlIO_setpos(PerlIO *f, SV *pos)
4815 Fpos_t *fpos = (Fpos_t *) SvPV(pos, len);
4816 if (f && len == sizeof(Fpos_t)) {
4817 #if defined(USE_64_BIT_STDIO) && defined(USE_FSETPOS64)
4818 return fsetpos64(f, fpos);
4820 return fsetpos(f, fpos);
4824 SETERRNO(EINVAL, SS_IVCHAN);
4830 #undef PerlIO_getpos
4832 PerlIO_getpos(PerlIO *f, SV *pos)
4835 Off_t posn = PerlIO_tell(f);
4836 sv_setpvn(pos, (char *) &posn, sizeof(posn));
4837 return (posn == (Off_t) - 1) ? -1 : 0;
4840 #undef PerlIO_getpos
4842 PerlIO_getpos(PerlIO *f, SV *pos)
4847 #if defined(USE_64_BIT_STDIO) && defined(USE_FSETPOS64)
4848 code = fgetpos64(f, &fpos);
4850 code = fgetpos(f, &fpos);
4852 sv_setpvn(pos, (char *) &fpos, sizeof(fpos));
4857 #if (defined(PERLIO_IS_STDIO) || !defined(USE_SFIO)) && !defined(HAS_VPRINTF)
4860 vprintf(char *pat, char *args)
4862 _doprnt(pat, args, stdout);
4863 return 0; /* wrong, but perl doesn't use the return
4868 vfprintf(FILE *fd, char *pat, char *args)
4870 _doprnt(pat, args, fd);
4871 return 0; /* wrong, but perl doesn't use the return
4877 #ifndef PerlIO_vsprintf
4879 PerlIO_vsprintf(char *s, int n, const char *fmt, va_list ap)
4881 int val = vsprintf(s, fmt, ap);
4883 if (strlen(s) >= (STRLEN) n) {
4885 (void) PerlIO_puts(Perl_error_log,
4886 "panic: sprintf overflow - memory corrupted!\n");
4894 #ifndef PerlIO_sprintf
4896 PerlIO_sprintf(char *s, int n, const char *fmt, ...)
4901 result = PerlIO_vsprintf(s, n, fmt, ap);